wagtail/docs
jacobtoppm 23af29d35c Use AdminOnlyMenuItem in both code samples in reports docs 2020-04-07 12:13:17 +01:00
..
_static
advanced_topics Use AdminOnlyMenuItem in both code samples in reports docs 2020-04-07 12:13:17 +01:00
contributing
editor_manual
getting_started Remove support for Django 2.1 (#5840) 2020-02-18 13:55:53 +00:00
reference Update BaseSetting to make it easier to utilise QuerySet.select_related() for more complex settings which reference related objects (such as pages) 2020-04-03 22:01:08 +01:00
releases Release notes for #5932 2020-04-03 22:01:08 +01:00
topics
Makefile
README.md
autobuild.sh
conf.py
favicon.ico
index.rst
logo.png
requirements.txt
spelling_wordlist.txt
support.rst

README.md

Wagtail docs

These are Sphinx docs, automatically built at https://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.