wagtail/docs
Matt Westcott 80cb6e16e7 prepare for 0.8.6 release
Conflicts:
	CHANGELOG.txt
	wagtail/project_template/requirements.txt
	wagtail/wagtailcore/__init__.py
2015-03-10 17:32:14 +00:00
..
_static
contrib_components
core_components
editor_manual
getting_started
howto
reference
releases prepare for 0.8.6 release 2015-03-10 17:32:14 +00:00
Makefile
README.md
autobuild.sh
conf.py
index.rst
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.