wagtail/docs
Liam Brenner ca846a5941 Add logout success message 2016-05-10 20:08:57 +03:00
..
_static/images
advanced_topics Tweaks to image serve view docs (#2588) 2016-05-10 14:56:12 +01:00
contributing Changed indentation on all code samples to 4 spaces. 2016-04-28 10:57:22 +01:00
editor_manual
getting_started add note about Wagtail <=1.4 syntax for search_fields 2016-05-02 18:42:21 +01:00
reference Make api_fields a list 2016-05-10 19:35:41 +03:00
releases Add logout success message 2016-05-10 20:08:57 +03:00
topics Update documentation and code to put mixin first 2016-05-04 14:05:33 +01: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.