wagtail/docs
Matt Westcott b62faf73ba Clarify 'the directory containing wagtaildemo' - fixes #1651 2015-09-01 10:13:16 +01:00
..
_static/images
advanced_topics
contributing Clarify 'the directory containing wagtaildemo' - fixes #1651 2015-09-01 10:13:16 +01:00
editor_manual
getting_started
reference
releases
topics
Makefile
README.md
autobuild.sh
conf.py
index.rst
logo.png
requirements.txt
spelling_wordlist.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 Wagtail's development requirements (in the root Wagtail directory):

pip install -r requirements-dev.txt

To build the documentation for browsing, from this directory run:

``make html`` 

then open _build/html/index.html in a browser.

To rebuild automatically while editing the documentation, from this directory run:

``sphinx-autobuild . _build``

The online editor at http://rst.ninjs.org/ is a helpful tool for checking reStructuredText syntax.