wagtail/docs
Matt Westcott 566fa3a26f Release note for #1670 / #1850 / #1854 2015-10-26 12:58:36 +00:00
..
_static/images
advanced_topics
contributing Move wagtailsettings into contrib module 2015-10-21 16:39:09 +11:00
editor_manual
getting_started
reference Merge branch 'merge-settings' of https://github.com/takeflight/wagtail into takeflight-merge-settings 2015-10-23 10:31:27 +01:00
releases Release note for #1670 / #1850 / #1854 2015-10-26 12:58:36 +00:00
topics Release notes for #1810, #1835, #1812 2015-10-20 11:16:09 +01:00
Makefile
README.md Removed backticks from readme 2015-10-23 22:04:56 +02:00
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.