wagtail/docs
Jeffrey Hearn 94af650c83 Spellchecked, cleaned, and Edit API section expanded
Added to edit api, fixed queryset example code, stubbed out Page ref

Some cleanup of the edit api doc

Some cleanup of the frontend doc

Added to edit api docs

Added to edit api docs
2014-05-25 16:39:08 -04:00
..
_static/css added editors guide docs 2014-03-25 14:14:18 +00:00
building_your_site Spellchecked, cleaned, and Edit API section expanded 2014-05-25 16:39:08 -04:00
editor_manual adding incomplete front end developer documentation 2014-05-22 17:19:40 +01:00
images added editors guide docs 2014-03-25 14:14:18 +00:00
Makefile
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 fixed pygments thing 2014-05-22 19:50:44 -04:00
contributing.rst
deploying.rst
editing_api.rst Spellchecked, cleaned, and Edit API section expanded 2014-05-25 16:39:08 -04:00
form_builder.rst Add form builder documentation 2014-05-22 15:11:30 +01:00
gettingstarted.rst Typo fix 2014-05-23 15:33:21 +01:00
index.rst Merged with docs coming from torchbox 2014-05-22 19:25:30 -04:00
model_recipes.rst Spellchecked, cleaned, and Edit API section expanded 2014-05-25 16:39:08 -04:00
performance.rst
roadmap.rst Add form builder documentation 2014-05-22 15:11:30 +01:00
snippets.rst Spellchecked, cleaned, and Edit API section expanded 2014-05-25 16:39:08 -04:00
static_site_generation.rst Static site generation docs update 2014-05-22 17:51:55 +01:00
support.rst
wagtail_search.rst Spellchecked, cleaned, and Edit API section expanded 2014-05-25 16:39:08 -04: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.