wagtail/docs
Matt Westcott 19f370c20a Add pointers to the new integrating-with-Django docs 2015-11-10 21:45:21 +00:00
..
_static/images
advanced_topics
contributing Move wagtailsettings into contrib module 2015-10-21 16:39:09 +11:00
editor_manual
getting_started Add pointers to the new integrating-with-Django docs 2015-11-10 21:45:21 +00:00
reference Add a can_choose_root flag to PageChooserPanel. 2015-11-02 15:12:42 +00:00
releases Created 1.3 changelog and release notes 2015-11-04 12:20:07 +00:00
topics Add a can_choose_root flag to PageChooserBlock 2015-11-02 15:12:42 +00: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.