wagtail/docs
Matt Westcott 16bc148916 Fill in release date for 2.3 2018-10-23 15:39:56 +01:00
..
_static
advanced_topics Fixes reference to the wagtailsearch section 2018-10-23 15:51:14 +02:00
contributing
editor_manual
getting_started Remove notes about URL confs for Django<2.0 2018-10-18 11:25:12 +01:00
reference
releases Fill in release date for 2.3 2018-10-23 15:39:56 +01:00
topics
Makefile
README.md
autobuild.sh
conf.py
favicon.ico
index.rst Fix broken link to bakerydemo (#4834) 2018-10-21 11:38:28 +02:00
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.