wagtail/docs
Dan Braghis c174de8724 Rename construct_wagtail_edit_bird hook 2015-04-03 13:36:32 +01:00
..
_static
contrib "register" should be "reciever" 2015-04-01 17:14:20 +01:00
editor_manual
getting_started
howto Remove mention of celery from docs 2015-03-31 10:29:58 +01:00
images
pages Merge pull request #1131 from negletios/documentation-fixes 2015-03-31 16:59:03 +01:00
reference Rename construct_wagtail_edit_bird hook 2015-04-03 13:36:32 +01:00
releases Merge pull request #1031 from kaedroho/wagtailapi 2015-04-01 14:28:01 +01:00
search Fixed import for pageurl tag which has moved from pageurl to wagtailcore_tags library 2015-03-29 16:22:33 +02: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.