wagtail/docs
Matt Westcott deee02e4d7 Release note for #1391 2015-10-05 18:41:48 +01:00
..
_static/images
advanced_topics Release note for #1391 2015-10-05 18:41:48 +01:00
contributing Normalise all code blocks in the docs 2015-10-05 16:55:58 +01:00
editor_manual
getting_started
reference Normalise all code blocks in the docs 2015-10-05 16:55:58 +01:00
releases Release note for #1391 2015-10-05 18:41:48 +01:00
topics Normalise all code blocks in the docs 2015-10-05 16:55:58 +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 -r requirements-dev.txt

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.