wagtail/docs
Christian Peters 9257a4a1dc Switching from undefined/indeterminate queryset to a defined one. (#3468) 2017-03-21 10:38:31 +01:00
..
_static/images
advanced_topics Reinstate underscore in fields param, as per 40842fe8bf (commitcomment-21183519) 2017-03-07 11:03:30 +00:00
contributing
editor_manual Add note that promoted search results are an optional feature (#3343) 2017-02-21 10:57:25 +00:00
getting_started
reference Mark API v1 documentation as deprecated (#3429) 2017-03-07 10:49:19 +00:00
releases Switching from undefined/indeterminate queryset to a defined one. (#3468) 2017-03-21 10:38:31 +01:00
topics Document get_rendition() 2017-02-21 22:48:20 +00:00
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.