wagtail/docs
Matt Westcott e681cb3626 Add documentation about permission configuration 2016-11-03 16:10:09 +00:00
..
_static/images
advanced_topics Update PageViewRestriction model to support group/login restriction type 2016-10-27 16:42:08 +03:00
contributing We don't have t-shirts any more :-( 2016-10-27 20:55:19 +01:00
editor_manual
getting_started
reference
releases Update release note and credits for #3071 2016-11-01 14:05:05 +00:00
topics Add documentation about permission configuration 2016-11-03 16:10:09 +00: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.