wagtail/docs
Matt Westcott f1111f640e Merge branch 'fix/foreign_key_warning_only' 2014-11-12 16:24:21 +00:00
..
_static
contrib_components Update frontendcache.rst 2014-10-30 16:25:15 +00:00
core_components Front-end cache is no longer necessary for image generator 2014-11-05 10:13:39 +00:00
editor_manual
getting_started
howto
reference
releases Merge branch 'fix/foreign_key_warning_only' 2014-11-12 16:24:21 +00:00
Makefile
README.md
autobuild.sh
conf.py
index.rst
requirements.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 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.