wagtail/docs
Tom Dyson 22b32d767e Update installation docs
wagtail start command needs pip install requirements.txt in 0.6
2014-09-17 11:17:02 +01:00
..
_static
contrib_components
core_components copyediting on parent_page_types documentation 2014-09-16 11:55:05 +01:00
editor_manual Additions to the 'getting started' documentation so that we're not under-selling the demo site as a way to get started 2014-09-15 18:06:09 +01:00
getting_started Update installation docs 2014-09-17 11:17:02 +01:00
howto side-step the 'a large number of emails is' vs 'a large number of emails are' grammatical debate 2014-09-11 14:30:38 +01:00
reference
releases release note for #491 2014-09-16 15:47:40 +01:00
Makefile
README.md
autobuild.sh
conf.py
index.rst Move getting_started page to an 'installation' page within a Getting Started section 2014-09-11 16:01:22 +01:00
requirements.txt
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.