wagtail/docs
Matt Westcott c2a183f19f Documentation tweaks as per https://github.com/torchbox/wagtail/pull/1815#commitcomment-13736415 https://github.com/torchbox/wagtail/pull/1815#commitcomment-13736421 2015-10-13 15:17:47 +01:00
..
_static/images added clarification about template tags to tutorial 2015-10-05 22:01:03 +13:00
advanced_topics Fixed typo in Jinja2 docs 2015-10-08 16:59:58 +01:00
contributing Normalise all code blocks in the docs 2015-10-05 16:55:58 +01:00
editor_manual
getting_started added clarification about template tags to tutorial 2015-10-05 22:01:03 +13:00
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 #1702 2015-10-13 00:19:51 +01:00
topics Documentation tweaks as per https://github.com/torchbox/wagtail/pull/1815#commitcomment-13736415 https://github.com/torchbox/wagtail/pull/1815#commitcomment-13736421 2015-10-13 15:17:47 +01:00
Makefile
README.md
autobuild.sh
conf.py
index.rst Renamed to "Page models" 2015-10-05 21:07:09 +01:00
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.