wagtail/docs
Matt Westcott 4a3bc94185 Add screenshots to 1.5 release notes 2016-05-19 15:49:04 +01:00
..
_static/images Add screenshots to 1.5 release notes 2016-05-19 15:49:04 +01:00
advanced_topics Added a missing link to release notes 2016-05-17 16:55:59 +01:00
contributing
editor_manual
getting_started
reference Rename table_block.fields to table_block.blocks 2016-05-18 15:51:54 +01:00
releases Add screenshots to 1.5 release notes 2016-05-19 15:49:04 +01:00
topics
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.