wagtail/docs
Matt Westcott 2b64922a05 Add release note re removal of Python 2.7, Django 1.8 and Django 1.10 support 2017-10-11 17:31:08 +01:00
..
_static/images
advanced_topics Eliminate references to wagtaildemo from the docs 2017-10-11 16:58:30 +01:00
contributing Eliminate references to wagtaildemo from the docs 2017-10-11 16:58:30 +01:00
editor_manual
getting_started Eliminate references to wagtaildemo from the docs 2017-10-11 16:58:30 +01:00
reference
releases Add release note re removal of Python 2.7, Django 1.8 and Django 1.10 support 2017-10-11 17:31:08 +01:00
topics Eliminate references to wagtaildemo from the docs 2017-10-11 16:58:30 +01:00
Makefile
README.md
autobuild.sh
conf.py
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.