wagtail/docs
Karl Hobley deb2e0f9d8 Deprecate Page.get_other_siblings 2014-06-26 14:42:06 +01:00
..
_static/css added editors guide docs 2014-03-25 14:14:18 +00:00
building_your_site Deprecate Page.get_other_siblings 2014-06-26 14:42:06 +01: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 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 fixed pygments thing 2014-05-22 19:50:44 -04:00
contributing.rst wagtail -> Wagtail in contributing.rst 2014-06-18 17:17:14 +01:00
deploying.rst First pass at Sphinx docs 2014-02-18 17:45:31 +00:00
editing_api.rst add documentation for the construct_whitelister_element_rules hook 2014-06-20 16:08:50 +01:00
form_builder.rst Add form builder documentation 2014-05-22 15:11:30 +01:00
gettingstarted.rst Doc fix - use https rather than ssh for wagtaildemo clone 2014-06-16 09:39:06 +01:00
index.rst Merged with docs coming from torchbox 2014-05-22 19:25:30 -04:00
model_recipes.rst Edit API docs expanded with hooks, modelcluster, and InlinePanel usage 2014-06-03 23:09:27 -04:00
performance.rst Remove all reference to less/npm in docs and install scripts 2014-03-05 20:05:26 +00:00
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 Include Twitter account in support contacts. 2014-02-18 23:03:42 +00:00
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.