wagtail/docs
Karl Hobley 3188fc031a Added a link to AUTO_UPDATE docs from release notes 2015-05-29 17:00:09 +01:00
..
_static/images
advanced_topics Renamed howto to advanced topics 2015-05-28 12:58:50 +01:00
contributing
editor_manual
getting_started Renamed howto to advanced topics 2015-05-28 12:58:50 +01:00
reference Fix typos 2015-05-29 14:21:08 +01:00
releases Added a link to AUTO_UPDATE docs from release notes 2015-05-29 17:00:09 +01:00
topics Added a link to AUTO_UPDATE docs from release notes 2015-05-29 17:00:09 +01:00
Makefile
README.md
autobuild.sh
conf.py
index.rst Renamed howto to advanced topics 2015-05-28 12:58:50 +01:00
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.