wagtail/docs
Matt Westcott 97c98e170a Fill in release date for 1.13.1 2017-11-17 11:15:34 +00:00
..
_static/images
advanced_topics Fix syntax error in ImageRenditionField example 2017-11-12 18:07:38 +00:00
contributing
editor_manual
getting_started
reference add note about django-treebeard api 2017-11-12 18:13:23 +00:00
releases Fill in release date for 1.13.1 2017-11-17 11:15:34 +00:00
topics Add explicit requirement for image and filter 2017-11-14 20:10:45 +00:00
Makefile
README.md
autobuild.sh
conf.py
index.rst
logo.png
readthedocs.yml
requirements.txt
spelling_wordlist.txt
support.rst Mention Slack on support documentation 2017-11-15 21:06:45 +00:00

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.