wagtail/docs
Matt Westcott c51177a0fa Release notes for #2858 / #2859 2016-07-21 12:03:53 +01:00
..
_static/images
advanced_topics
contributing Add 'issue tracking' docs (#2794) 2016-07-19 16:17:54 +01:00
editor_manual
getting_started Make /admin a link in the Getting Started tutorial 2016-07-20 09:41:03 +01:00
reference
releases Release notes for #2858 / #2859 2016-07-21 12:03:53 +01:00
topics docs: fix typo (#2845) 2016-07-15 21:58:47 +03: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.