wagtail/docs
Matt Westcott bdaf696cd2 Release note / docs for #2257 2016-06-10 14:26:30 +01:00
..
_static/images
advanced_topics Documented the WAGTAILIMAGES_MAX_UPLOAD_SIZE (#2683) 2016-06-05 18:16:13 +01:00
contributing
editor_manual
getting_started
reference Release note / docs for #2257 2016-06-10 14:26:30 +01:00
releases Release note / docs for #2257 2016-06-10 14:26:30 +01:00
topics Use python_2_unicode_compatible in snippets.rst (#2688) 2016-06-07 13:49:28 +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.