wagtail/docs
Matt Westcott 6612f0adf3 Release note for #1529 2015-10-09 16:41:32 +01:00
..
_static/images
advanced_topics Fixed typo in Jinja2 docs 2015-10-08 16:59:58 +01:00
contributing
editor_manual
getting_started
reference Merge branch 'inline-panel-min-max' of https://github.com/kaedroho/wagtail into kaedroho-inline-panel-min-max 2015-10-09 15:42:54 +01:00
releases Release note for #1529 2015-10-09 16:41:32 +01:00
topics Release / upgrade consideration note for #1478 2015-10-07 20:02:25 +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.