wagtail/docs
Karl Hobley df446f1475 0.9 => 1.0 2015-04-09 17:06:32 +01:00
..
_static
contrib Removed all versionadded older than 0.7 2015-04-09 17:03:33 +01:00
editor_manual
getting_started
howto Removed all versionadded older than 0.7 2015-04-09 17:03:33 +01:00
images Removed all versionchanged older than 0.7 2015-04-09 17:05:26 +01:00
pages 0.9 => 1.0 2015-04-09 17:06:32 +01:00
reference Removed all versionadded older than 0.7 2015-04-09 17:03:33 +01:00
releases
search Removed all versionchanged older than 0.7 2015-04-09 17:05:26 +01:00
Makefile
README.md
autobuild.sh
conf.py
form_builder.rst
index.rst
requirements.txt
snippets.rst
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 Sphinx and the RTD theme:

pip install Sphinx
pip install sphinx-rtd-theme

Then make html from this directory, and open _build/html/index.html in your browser.

We've provided a watchdog script (based on @jacobian's snippet) to auto-build your local docs when you save them. Install watchdog:

pip install watchdog

Then run ./autobuild.sh before you start editing.

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