wagtail/docs
John-Scott Atlakson 068c3f2964 Added `AbstractGroupApprovalTask` to simplify customizing behavior 2024-03-14 07:38:07 +10:00
..
_static
_templates
advanced_topics Remove lesser-used archive formats from WAGTAILDOCS_EXTENSIONS list 2024-03-07 12:19:23 +00:00
contributing
editor_manual
extending Added `AbstractGroupApprovalTask` to simplify customizing behavior 2024-03-14 07:38:07 +10:00
getting_started Remove lesser-used archive formats from WAGTAILDOCS_EXTENSIONS list 2024-03-07 12:19:23 +00:00
public
reference Remove support for customising the number of entries on the image listing 2024-03-11 09:55:41 +00:00
releases Added `AbstractGroupApprovalTask` to simplify customizing behavior 2024-03-14 07:38:07 +10:00
topics Update deployment docs to cover XSS risks 2024-03-07 12:19:22 +00:00
tutorial
Makefile
README.md
autobuild.sh
conf.py
favicon.ico
index.rst
logo.png
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 MyST playground at Curvenote or the MyST-Markdown VS Code Extension are helpful tools for working with the MyST syntax.