wagtail/docs
Mikalai Radchuk 9d64068082 Release notes for #3588 2017-05-23 20:55:43 +01:00
..
_static/images Update documentation referring to the explorer menu 2017-05-17 13:14:50 +01:00
advanced_topics
contributing
editor_manual Update documentation referring to the explorer menu 2017-05-17 13:14:50 +01:00
getting_started
reference
releases Release notes for #3588 2017-05-23 20:55:43 +01:00
topics Cache `Site.get_site_root_paths` in the request scope (#3354) 2017-05-16 15:24:48 +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 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.