wagtail/docs
Matt Westcott e603080092 Release note for #3999 2017-11-07 16:45:55 +00:00
..
_static/images
advanced_topics Remove dead links to API v1 docs 2017-11-03 17:03:57 +00:00
contributing
editor_manual
getting_started
reference Remove dead links to API v1 docs 2017-11-03 17:03:57 +00:00
releases Release note for #3999 2017-11-07 16:45:55 +00:00
topics Remove ES 1.x search backend 2017-11-06 14:27:27 +00:00
Makefile
README.md
autobuild.sh
conf.py
index.rst
logo.png
readthedocs.yml
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.