wagtail/docs
Matt Westcott 8dc1d9c342 Document the steps for creating a filter_spec migration for a custom image model 2016-09-20 15:38:36 +01:00
..
_static/images
advanced_topics Add content_panels declarations to i18n duplicate tree example code - fixes #2981 2016-09-06 10:44:33 +01:00
contributing Mention where to access the styleguide - fixes #3009 2016-09-19 13:49:52 +01:00
editor_manual
getting_started
reference Fix underlines 2016-09-19 13:51:04 +01:00
releases Document the steps for creating a filter_spec migration for a custom image model 2016-09-20 15:38:36 +01:00
topics
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.