wagtail/docs
Nick Smith df9a5e31fa Allow referencing models by string representation in SnippetChooserBlock 2016-09-30 17:11:51 +01:00
..
_static/images
advanced_topics Allow configuration or override of QueryDailyHits garbage collection 2016-09-22 14:21:38 +01:00
contributing Adds "Supported versions of Django" 2016-09-21 18:50:44 +01:00
editor_manual
getting_started
reference Add documentation to help with customisation of `contrib.modeladmin` 2016-09-28 20:52:19 +01:00
releases Allow referencing models by string representation in SnippetChooserBlock 2016-09-30 17:11:51 +01:00
topics Implemented annotate_score on SearchResults 2016-09-22 12:03:23 +01:00
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.