wagtail/docs
Matt Westcott c2421246a8 Release note for #1494 2015-08-26 16:38:08 +01:00
..
_static/images
advanced_topics Tweaks based on feedback from @tomdyson 2015-08-24 12:09:47 +01:00
contributing
editor_manual Merge pull request #1635 from benebun/benebun-patch-editor_manual 2015-08-24 09:14:24 +01:00
getting_started
reference Documentation for #1621 2015-08-25 16:15:31 +01:00
releases Release note for #1494 2015-08-26 16:38:08 +01:00
topics Fixed indentation problems 2015-08-17 12:49:54 +02: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.