wagtail/docs
Matt Westcott c6140a06f7 Release note / contributor entry for #2256 2016-03-01 15:26:53 +00:00
..
_static/images
advanced_topics Fix custom image docs to indicate that fields must be non-required 2016-03-01 12:07:35 +00:00
contributing Update node.js version requirements 2016-02-29 15:55:02 +00:00
editor_manual Correcting typo int The Dashboard doc 2016-02-16 15:51:57 -05:00
getting_started Removed django-compressor 2016-02-03 16:16:11 +00:00
reference Add get_site and get_url_parts to the Page model reference docs 2016-03-01 12:11:14 +00:00
releases Release note / contributor entry for #2256 2016-03-01 15:26:53 +00:00
topics Tagging snippets documentation fix 2016-02-12 11:11:08 +00:00
Makefile
README.md Eliminate reference to requirements-dev.txt 2016-02-05 15:48:01 +00:00
autobuild.sh
conf.py Call `django.setup()` before making docs 2015-12-09 11:40:35 +00:00
index.rst Moved advanced image topics into advanced topics 2016-01-27 11:27:16 +00: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 -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.