wagtail/docs
Karl Hobley 1274a81e8d Updates to release notes 2014-07-08 13:55:19 +01:00
..
_static/css
building_your_site Merge branch 'master' into feature/fep2 2014-07-04 22:00:46 +01:00
editor_manual fix documentation syntax errors / warnings 2014-07-04 21:57:58 +01:00
images Added wagtail and django settings doc 2014-06-08 16:59:46 -04:00
releases Updates to release notes 2014-07-08 13:55:19 +01:00
Makefile
README.md
advanced_topics.rst
autobuild.sh
conf.py Update conf.py 2014-07-08 12:31:13 +01:00
contributing.rst wagtail -> Wagtail in contributing.rst 2014-06-18 17:17:14 +01:00
deploying.rst
editing_api.rst Merge branch 'master' into feature/fep2 2014-07-04 22:00:46 +01:00
form_builder.rst Added wagtail and django settings doc 2014-06-08 16:59:46 -04:00
frontend_cache_purging.rst fix documentation syntax errors / warnings 2014-07-04 21:57:58 +01:00
gettingstarted.rst fix documentation syntax errors / warnings 2014-07-04 21:57:58 +01:00
index.rst Merge branch 'master' into feature/fep2 2014-07-04 22:00:46 +01:00
management_commands.rst fix documentation syntax errors / warnings 2014-07-04 21:57:58 +01:00
model_recipes.rst update building_your_site and model_recipes docs to cover the new route/serve API 2014-07-04 17:50:26 +01:00
performance.rst
private_pages.rst Add developer docs for private pages 2014-07-04 20:56:34 +01:00
roadmap.rst
settings.rst Merge branch 'master' into feature/fep2 2014-07-04 22:00:46 +01:00
sitemap_generation.rst fix documentation syntax errors / warnings 2014-07-04 21:57:58 +01:00
snippets.rst
static_site_generation.rst Update example in static_site_generation docs to use new-style route API 2014-07-04 18:24:01 +01:00
support.rst
wagtail_search.rst fix documentation syntax errors / warnings 2014-07-04 21:57:58 +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.