wagtail/docs
Charlie Choiniere 0a9ae79ba4 Updated wagtail admin jQuery to version 2.2.1 2016-03-03 09:46:56 +00:00
..
_static/images
advanced_topics
contributing Add docs on committing code 2016-03-03 02:00:37 +02:00
editor_manual
getting_started
reference Add get_site and get_url_parts to the Page model reference docs 2016-03-01 12:11:14 +00:00
releases Updated wagtail admin jQuery to version 2.2.1 2016-03-03 09:46:56 +00:00
topics fixed font size rounding issue in firefox, added contrib notes 2016-03-03 12:29:28 +13: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.