wagtail/docs
Matt Westcott 2c9805dc3f Add upgrade consideration note re direct use of Filter and Rendition 2016-12-06 15:05:50 +00:00
..
_static/images
advanced_topics Switch to Rendition.filter_spec as the active field for looking up filters 2016-12-06 15:03:15 +00:00
contributing
editor_manual
getting_started Clarify '# ...' comments when omitting code in tutorial snippets 2016-12-01 13:43:19 +00:00
reference Add note that wagtailforms is not a replacement for Django forms (#3190) 2016-12-05 18:19:59 +00:00
releases Add upgrade consideration note re direct use of Filter and Rendition 2016-12-06 15:05:50 +00:00
topics
Makefile
README.md
autobuild.sh
conf.py
index.rst
logo.png
requirements.txt
spelling_wordlist.txt
support.rst

README.md

Wagtail docs

These are Sphinx docs, automatically built at http://docs.wagtail.io when the master branch is committed to Github. To build them locally, install Wagtail's development requirements (in the root Wagtail directory):

pip install -e .[testing,docs]

To build the documentation for browsing, from this directory run:

make html 

then open _build/html/index.html in a browser.

To rebuild automatically while editing the documentation, from this directory run:

sphinx-autobuild . _build

The online editor at http://rst.ninjs.org/ is a helpful tool for checking reStructuredText syntax.