wagtail/docs
Daniel Kirkham fb1d441ed5 Fix note markup in developing doc 2022-09-22 15:09:58 +10:00
..
_static Update editor manual screenshots 2022-09-12 21:57:43 +10:00
_templates
advanced_topics Fix code style of example in Wagtail API docs 2022-09-19 21:49:01 +10:00
contributing Fix note markup in developing doc 2022-09-22 15:09:58 +10:00
editor_manual Revert chooser button labels to "Choose another X" 2022-09-14 07:40:38 +10:00
extending Add changelog entry for 4.0 - bulk actions for snippets #8574 2022-09-19 19:40:46 +10:00
getting_started Add alternative text for all documentation screenshots 2022-09-12 21:57:43 +10:00
public
reference Add alternative text for all documentation screenshots 2022-09-12 21:57:43 +10:00
releases changelog for #9239 2022-09-22 15:06:27 +10:00
topics
Makefile
README.md
autobuild.sh
conf.py
favicon.ico
index.rst
logo.png
requirements.txt
spelling_wordlist.txt
support.md

README.md

Wagtail docs

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