wagtail/docs
Tom Dyson 69661b0455 1.8 release notes - 'other', not 'minor' (#3218) 2016-12-14 11:41:40 +00:00
..
_static/images Image / updated writeup for page privacy feature in 1.8 2016-12-09 15:30:46 +00:00
advanced_topics Switch to Rendition.filter_spec as the active field for looking up filters 2016-12-06 15:03:15 +00:00
contributing
editor_manual
getting_started Fix the inconsistent use of `blogpages` 2016-12-13 10:07:11 +00:00
reference
releases 1.8 release notes - 'other', not 'minor' (#3218) 2016-12-14 11:41:40 +00:00
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 -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.