wagtail/docs
Karl Hobley 974d593c85 Changelog/release note for #2405 2016-03-30 19:59:59 +01:00
..
_static/images
advanced_topics Updated to include TEMPLATE requirement for Django 1.9+ 2016-03-24 21:38:58 +00:00
contributing Add docs on making Wagtail compatible with multiple Django versions 2016-03-27 07:15:56 +02:00
editor_manual
getting_started Change Indexed.search_fields to be a listish thing 2016-03-24 21:05:09 +00:00
reference
releases Changelog/release note for #2405 2016-03-30 19:59:59 +01:00
topics Clarified wagtail userbar options and positioning 2016-03-27 14:23:47 +01: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.