0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 17:36:49 +01:00
wagtail/docs
2017-09-27 12:20:34 +01:00
..
_static/images Add 'The Zen of Wagtail' document 2017-09-27 12:20:34 +01:00
advanced_topics Allow overriding branding_logo on the 404 page 2017-09-21 13:25:12 +01:00
contributing Fix link to stylelint site in documentation 2017-08-26 19:07:08 +03:00
editor_manual Update documentation referring to the explorer menu 2017-05-17 13:14:50 +01:00
getting_started Add 'The Zen of Wagtail' document 2017-09-27 12:20:34 +01:00
reference Remove old versionadded annotations from the docs 2017-08-22 14:08:44 +01:00
releases Stop breadcrumb home icon from showing as ellipsis in Chrome 2017-09-26 16:18:22 +02:00
topics Change StreamField examples to use explicit required=False instead of required=True 2017-09-18 21:34:35 +01:00
autobuild.sh
conf.py
index.rst
logo.png
Makefile
README.md
requirements.txt
spelling_wordlist.txt
support.rst

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.