wagtail/docs
Nick Smith dea22d8fe0 Document custom queryset required approach 2015-09-23 09:31:35 +01:00
..
_static/images
advanced_topics Update documentation to indicate that SnippetChooserPanel no longer requires a snippet_type argument 2015-08-28 10:57:31 +01:00
contributing Clarify 'the directory containing wagtaildemo' - fixes #1651 2015-09-01 10:13:16 +01:00
editor_manual
getting_started
reference Rename `is_abstract` to `is_creatable` 2015-09-04 09:59:01 +10:00
releases Changelog for #1692 2015-09-18 11:29:50 +01:00
topics Document custom queryset required approach 2015-09-23 09:31:35 +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 -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.