wagtail/docs
jordan-bauer 998440cfa9 Remove buggy tab order customisations in CMS admin (#5383, #5351) 2019-06-18 12:49:16 +01:00
..
_static Adds Collections section to editor's guide 2019-06-17 10:13:49 +01:00
advanced_topics Remove buggy tab order customisations in CMS admin (#5383, #5351) 2019-06-18 12:49:16 +01:00
contributing Remove bad practice example from CSS guidelines 2019-06-06 17:04:23 +01:00
editor_manual Adds Collections section to editor's guide 2019-06-17 10:13:49 +01:00
getting_started Remove support for Python 3.4 2019-04-10 17:39:53 +01:00
reference Missing class imports 2019-06-11 11:53:19 +01:00
releases Remove buggy tab order customisations in CMS admin (#5383, #5351) 2019-06-18 12:49:16 +01:00
topics Add support for custom search handler classes to ModelAdmin's IndexView 2019-06-08 17:57:24 +01:00
Makefile
README.md
autobuild.sh
conf.py Add Wagtail Space Arnhem banner to documentation 2019-01-24 11:28:56 +00:00
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 Add note about not asking support questions in multiple places 2018-07-11 11:09:45 +01:00

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.