wagtail/docs
Karl Hobley 2801c913dc Docs update for #342 merge 2014-06-23 14:22:50 +01:00
..
_static/css
building_your_site Update frontenddevelopers.rst 2014-06-20 14:07:33 +01:00
editor_manual
images
Makefile
README.md
advanced_topics.rst
autobuild.sh
conf.py
contributing.rst wagtail -> Wagtail in contributing.rst 2014-06-18 17:17:14 +01:00
deploying.rst
editing_api.rst add documentation for the construct_whitelister_element_rules hook 2014-06-20 16:08:50 +01:00
form_builder.rst
gettingstarted.rst Doc fix - use https rather than ssh for wagtaildemo clone 2014-06-16 09:39:06 +01:00
index.rst
model_recipes.rst
performance.rst
roadmap.rst
snippets.rst
static_site_generation.rst
support.rst
wagtail_search.rst Docs update for #342 merge 2014-06-23 14:22:50 +01:00

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.