wagtail/docs
kevinhowbrook 31e3dab4ec Allow users to change their first and last name 2019-08-18 17:08:52 +10:00
..
_static Add caption field to TableBlock 2019-08-14 22:17:25 +02:00
advanced_topics
contributing
editor_manual
getting_started
reference Add caption field to TableBlock 2019-08-14 22:17:25 +02:00
releases Allow users to change their first and last name 2019-08-18 17:08:52 +10:00
topics Upgrade minimum 6.x release for Elasticsearch to 6.4.0 2019-08-18 15:37:11 +10:00
Makefile
README.md
autobuild.sh
conf.py
favicon.ico
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.