wagtail/docs
LB 3eac584c7c Make FormBuilder more easy to extend 2018-01-10 19:04:42 +10:00
..
_static make font more readable 2018-01-06 11:00:08 +10:00
advanced_topics Update documentation for rich text element whitelisting 2018-01-05 16:15:59 +00:00
contributing Add line break to makemigrations code snippet 2017-11-27 01:11:09 +00:00
editor_manual
getting_started add on_delete argument to ParentalKey & ForeignKey 2017-12-15 10:33:09 +00:00
reference Make FormBuilder more easy to extend 2018-01-10 19:04:42 +10:00
releases Make FormBuilder more easy to extend 2018-01-10 19:04:42 +10:00
topics Fix anchor syntax 2018-01-05 16:33:33 +00:00
Makefile
README.md
autobuild.sh
conf.py add wagtail colours to docs sidebar 2018-01-05 14:51:05 +10:00
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.