wagtail/docs
Matt Westcott dc0d18b6a4 Reorganise Hooks reference into meaningful sections 2016-02-11 10:53:03 +00:00
..
_static/images
advanced_topics Remove final references to django-compressor 2016-02-09 18:41:56 +00:00
contributing
editor_manual
getting_started
reference Reorganise Hooks reference into meaningful sections 2016-02-11 10:53:03 +00:00
releases Fixes to page ordering logic in explorer: 2016-02-11 10:42:01 +00:00
topics Fix PageQuerySet code overriding code snippet 2016-02-08 16:03:11 +03:00
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 -e .[testing,docs]

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.