0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-25 05:02:57 +01:00
wagtail/docs
2018-01-05 16:15:59 +00:00
..
_static add wagtail colours to docs sidebar 2018-01-05 14:51:05 +10:00
advanced_topics Update documentation for rich text element whitelisting 2018-01-05 16:15:59 +00:00
contributing
editor_manual
getting_started
reference Update documentation for rich text element whitelisting 2018-01-05 16:15:59 +00:00
releases Update documentation for rich text element whitelisting 2018-01-05 16:15:59 +00:00
topics
autobuild.sh
conf.py add wagtail colours to docs sidebar 2018-01-05 14:51:05 +10:00
index.rst
logo.png
Makefile
README.md
readthedocs.yml
requirements.txt
spelling_wordlist.txt
support.rst

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.