wagtail/docs
Neal Todd 5c3992686a Supported Django/Python versions note. 2014-04-28 09:50:05 +01:00
..
_static/css added editors guide docs 2014-03-25 14:14:18 +00:00
editor_manual added editors guide docs 2014-03-25 14:14:18 +00:00
images added editors guide docs 2014-03-25 14:14:18 +00:00
Makefile
README.md
autobuild.sh
building_your_site.rst
conf.py
contributing.rst
deploying.rst
gettingstarted.rst added editors guide docs 2014-03-25 14:14:18 +00:00
index.rst Supported Django/Python versions note. 2014-04-28 09:50:05 +01:00
performance.rst
roadmap.rst
support.rst
wagtail_search.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.