wagtail/docs
Matt Westcott b4a2e13cb0 Copy 1.13.2 release notes to master 2018-06-29 15:37:58 +01:00
..
_static
advanced_topics Merge branch 'docs-divio-cloud' of https://github.com/evildmp/wagtail into evildmp-docs-divio-cloud 2018-06-18 15:45:38 +01:00
contributing Add guideline on the use of British vs American English 2018-06-27 20:39:08 +01:00
editor_manual
getting_started
reference
releases Copy 1.13.2 release notes to master 2018-06-29 15:37:58 +01:00
topics Typo. 2018-06-20 15:33:49 +02:00
Makefile
README.md
autobuild.sh
conf.py
favicon.ico
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.