wagtail/docs
Matt Westcott 84efa88883 Release note for #3256
Conflicts:
	CHANGELOG.txt
	CONTRIBUTORS.rst
	docs/releases/index.rst
2017-01-26 12:38:11 +00:00
..
_static/images
advanced_topics Add convenience method for finding root page to navigation.py. Add context variables to home renderer. 2017-01-24 14:16:31 +00:00
contributing
editor_manual
getting_started Update tutorial wording to clarify that templates are not created automatically (#3290) 2017-01-25 19:57:44 +00:00
reference Fix a typo in a docstring 2017-01-25 21:34:25 +03:00
releases Release note for #3256 2017-01-26 12:38:11 +00: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.