wagtail/docs
Matt Westcott c87b400c7a Release note for #3799/#3820 2017-08-30 16:54:48 +01:00
..
_static/images
advanced_topics Adds docs for custom document models and get_document_model 2017-08-24 10:22:52 -07:00
contributing Fix link to stylelint site in documentation 2017-08-26 19:07:08 +03:00
editor_manual
getting_started
reference
releases Release note for #3799/#3820 2017-08-30 16:54:48 +01:00
topics Remove unused import in docs snippet. 2017-08-23 22:58:42 +01:00
Makefile
README.md
autobuild.sh
conf.py
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.