wagtail/docs
Karl Hobley 4ea06426ab Changelog/release note for #3277 2017-01-24 16:07:16 +00:00
..
_static/images Image / updated writeup for page privacy feature in 1.8 2016-12-09 15:30:46 +00:00
advanced_topics Add convenience method for finding root page to navigation.py. Add context variables to home renderer. 2017-01-24 14:16:31 +00:00
contributing Specify version 4.x, 5.x or 6.x of Node 2017-01-03 16:47:32 +00:00
editor_manual
getting_started Remove redundant filter() in tutorial example. Fixes #3280 2017-01-19 17:39:28 +00:00
reference Mention addition to INSTALLED_APPS in routablepage docs 2017-01-23 17:07:19 +00:00
releases Changelog/release note for #3277 2017-01-24 16:07:16 +00:00
topics Documentation and release notes for #3275 2017-01-16 18:51:42 +00:00
Makefile
README.md
autobuild.sh
conf.py
index.rst
logo.png
requirements.txt
spelling_wordlist.txt
support.rst Point people to Stack Overflow for support queries in preference to the Google group (#3255) 2017-01-03 16:02:24 +00:00

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.