wagtail/docs
Timo Rieber 16120404c6 Fixed import for pageurl tag which has moved from pageurl to wagtailcore_tags library 2015-03-29 16:22:33 +02:00
..
_static
contrib Recommend defining subpage_urls as a property 2015-03-26 16:56:22 +00:00
editor_manual
getting_started
howto
images
pages StreamField release note 2015-03-27 11:06:52 +00:00
reference Moved hooks into their own file 2015-03-26 14:17:35 +00:00
releases version 0.9 shall now be known as version 1.0 2015-03-27 15:36:18 +00:00
search Fixed import for pageurl tag which has moved from pageurl to wagtailcore_tags library 2015-03-29 16:22:33 +02:00
Makefile
README.md
autobuild.sh
conf.py
form_builder.rst
index.rst Renamed "For frontend developers" to "Writing templates" 2015-03-26 14:17:35 +00:00
requirements.txt Update django-taggit in docs 2015-03-27 15:15:57 +00:00
snippets.rst
support.rst

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.