wagtail/docs
Matt Westcott 24c984192e
Add documentation for custom page listings via PageListingViewSet
2024-03-07 09:57:10 +00:00
..
_static
_templates
advanced_topics Add documentation for custom page listings via PageListingViewSet 2024-03-07 09:57:10 +00:00
contributing Docs - Update and fix broken links 2024-02-16 17:23:53 +10:00
editor_manual
extending Update template components & Laces references 2024-02-29 07:50:46 +10:00
getting_started Update tutorial.md (#11622) 2024-02-08 15:06:21 +00:00
public
reference Fixed formatting typo in --purge-only command flag 2024-02-29 07:32:27 +10:00
releases fix: MutationObserver in dirty form check only tests direct descendants 2024-03-07 08:09:37 +10:00
topics Allow displaying permissions linked to the Admin model's content type (#11668) 2024-02-27 22:16:51 +00:00
tutorial Fix typos of base/models.py (#11682) 2024-02-21 11:57:01 +00:00
Makefile Add --jobs auto to build docs in parallel 2024-03-05 07:47:11 +10:00
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.