wagtail/docs
Neal Todd 49b72d2481 Text amendments. 2014-07-08 13:21:44 +01:00
..
_static/css added editors guide docs 2014-03-25 14:14:18 +00:00
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
Makefile First pass at Sphinx docs 2014-02-18 17:45:31 +00:00
README.md auto doc builder notes 2014-03-11 17:39:13 +00:00
advanced_topics.rst Merged with docs coming from torchbox 2014-05-22 19:25:30 -04:00
autobuild.sh Roadmap update and auto doc builder 2014-03-11 17:39:13 +00:00
conf.py Update conf.py 2014-07-08 12:31:13 +01:00
contributing.rst Text amendments. 2014-07-08 13:21:44 +01:00
deploying.rst First pass at Sphinx docs 2014-02-18 17:45:31 +00:00
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 Remove all reference to less/npm in docs and install scripts 2014-03-05 20:05:26 +00:00
private_pages.rst Add developer docs for private pages 2014-07-04 20:56:34 +01:00
roadmap.rst Add form builder documentation 2014-05-22 15:11:30 +01:00
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 Spellchecked, cleaned, and Edit API section expanded 2014-05-25 16:39:08 -04:00
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 Include Twitter account in support contacts. 2014-02-18 23:03:42 +00:00
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.