wagtail/docs
Josh Schneier 6d1a9efbb6 Update documentation and code to put mixin first 2016-05-04 14:05:33 +01:00
..
_static/images
advanced_topics Add documentation on the base_form_class attribute 2016-05-03 14:00:21 +01:00
contributing
editor_manual
getting_started
reference Add documentation on the base_form_class attribute 2016-05-03 14:00:21 +01:00
releases Changelog/release note for #2528 2016-05-04 12:29:21 +01: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.