wagtail/docs
Matt Westcott c35c1f360a Release note for #2439 2016-04-22 17:22:40 +01:00
..
_static/images
advanced_topics Added openshift deployment infos using wagtail-openshift-quickstart 2016-04-06 11:44:25 +01:00
contributing
editor_manual
getting_started
reference Added wagtailmodeladmin to contrib with docs 2016-04-14 15:03:49 +01:00
releases Release note for #2439 2016-04-22 17:22:40 +01:00
topics The destination of the ParentalKey should be a subclass of ClusterableModel 2016-04-03 20:18:57 +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.