0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 01:22:07 +01:00
wagtail/docs
2017-05-30 20:39:30 +01:00
..
_static/images Update documentation referring to the explorer menu 2017-05-17 13:14:50 +01:00
advanced_topics Fix incorrect field panels in custom form example 2017-04-28 15:28:25 +01:00
contributing Document pep8 issues to ignore (#3503) 2017-03-25 15:10:12 +01:00
editor_manual Update documentation referring to the explorer menu 2017-05-17 13:14:50 +01:00
getting_started Update docs to mention Django 1.11 / Python 3.6 support 2017-04-20 10:57:22 +01:00
reference Make tagging example not rely on an unmentioned 'blogs' method - fixes #3602 2017-05-30 20:39:30 +01:00
releases Release notes for #3588 2017-05-23 20:55:43 +01:00
topics Cache Site.get_site_root_paths in the request scope (#3354) 2017-05-16 15:24:48 +01:00
autobuild.sh [skip ci] added commment about autobuild inside vms (#3379) 2017-02-16 21:29:10 +00:00
conf.py
index.rst
logo.png
Makefile add way of autocompile documentation 2017-02-20 20:24:17 +00:00
README.md
requirements.txt update modelcluster/taggit in doc dependencies 2017-04-05 22:08:38 +01:00
spelling_wordlist.txt Remove references to Gondor.io in documentation. 2017-01-30 12:36:26 +00:00
support.rst Point people to Stack Overflow for support queries in preference to the Google group (#3255) 2017-01-03 16:02:24 +00:00

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.