wagtail/docs
Tom Dyson 4e7b9bfd98 Merge pull request #1019 from zerolab/remove-build-dependencies
Remove build dependencies. Fixes #985 and #958
2015-02-23 11:20:29 +00:00
..
_static
contrib_components
core_components
editor_manual
getting_started Separate dependencies in two subsections 2015-02-23 11:13:37 +00:00
howto
reference Update page.rst 2015-02-21 10:05:41 +00:00
releases Add changelog/release notes for #935/#1013 2015-02-23 10:01:38 +00:00
Makefile
README.md
autobuild.sh
conf.py
index.rst Minor docs cleanup 2015-02-22 11:29:24 +00: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.