wagtail/docs
Patrick Woods 3f0972507b Initial scheduled publishing documentation. 2018-01-15 22:58:00 +00:00
..
_static
advanced_topics Add setting to disable notification to superusers -- Fixes #3969 2018-01-10 17:26:02 +00:00
contributing
editor_manual Initial scheduled publishing documentation. 2018-01-15 22:58:00 +00:00
getting_started
reference Initial scheduled publishing documentation. 2018-01-15 22:58:00 +00:00
releases Simplifies edit handlers by removing redundant classes. 2018-01-13 17:21:36 +00:00
topics
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.