wagtail/docs
Tim Heap e225481f2f Add documentation for using Jinja2 2015-10-01 16:00:40 +10:00
..
_static/images
advanced_topics Add documentation for using Jinja2 2015-10-01 16:00:40 +10:00
contributing
editor_manual
getting_started Loudly highlight the fact that libjpeg and zlib are required 2015-09-22 22:54:47 +01:00
reference added docs about hostnames 2015-09-27 01:41:52 +12:00
releases Release note for #1704 2015-09-18 16:25:27 +01:00
topics Add documentation for using Jinja2 2015-10-01 16:00:40 +10: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 -r requirements-dev.txt

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.