wagtail/docs
Dan Braghis be3be40389 Release/changelog notes for #1109 2015-06-01 14:30:07 +01:00
..
_static/images
advanced_topics Moved page editor customisation to customisation section 2015-05-30 23:17:39 +01:00
contributing
editor_manual Fixed a couple of links in editor manual 2015-06-01 14:12:48 +01:00
getting_started
reference Moved page editor customisation to customisation section 2015-05-30 23:17:39 +01:00
releases Release/changelog notes for #1109 2015-06-01 14:30:07 +01:00
topics Added missing "versionadded" 2015-06-01 09:54:17 +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 Wagatail's development requirements (in the root Wagtail directory):

pip install 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.