wagtail/docs
Rob Moorman 82a8202bb2 Release notes for #3483 2017-03-22 20:56:30 +01:00
..
_static/images Add image for m2m feature in release notes 2017-02-06 12:07:32 +00:00
advanced_topics Setting for your most recent edits (#3483) 2017-03-22 20:47:57 +01:00
contributing Add browser support targets in contributing guidelines 2017-02-20 20:46:40 +00:00
editor_manual Add note that promoted search results are an optional feature (#3343) 2017-02-21 10:57:25 +00:00
getting_started Release note for #3305 2017-02-03 21:24:57 +00:00
reference Mark API v1 documentation as deprecated (#3429) 2017-03-07 10:49:19 +00:00
releases Release notes for #3483 2017-03-22 20:56:30 +01:00
topics Document get_rendition() 2017-02-21 22:48:20 +00:00
Makefile add way of autocompile documentation 2017-02-20 20:24:17 +00:00
README.md
autobuild.sh [skip ci] added commment about autobuild inside vms (#3379) 2017-02-16 21:29:10 +00:00
conf.py
index.rst
logo.png
requirements.txt
spelling_wordlist.txt Remove references to Gondor.io in documentation. 2017-01-30 12:36:26 +00:00
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.