wagtail/docs
Matt Westcott a83a16de5c release note for #1114 2015-03-30 12:41:01 +01:00
..
_static
contrib
editor_manual
getting_started
howto
images
pages
reference release note for #1114 2015-03-30 12:41:01 +01:00
releases release note for #1114 2015-03-30 12:41:01 +01:00
search
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.