wagtail/docs
Levi Adler 6bd7515663 Reduce queries and speed up sitemap generation with PageQuerySet.specific (#3727) 2017-07-28 16:07:16 +01:00
..
_static/images
advanced_topics Class based embed finders and new embed finder configuration (#2127) 2017-07-03 18:28:13 +01:00
contributing
editor_manual
getting_started
reference Backslash is not necessary when multi-line expression is parenthesized. 2017-07-18 09:56:42 +03:00
releases Reduce queries and speed up sitemap generation with PageQuerySet.specific (#3727) 2017-07-28 16:07:16 +01:00
topics Update documentation to reflect specific behavior of form_classname meta attribute 2017-07-28 15:41:38 +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.