wagtail/docs
Matt Westcott 8db9bf3ee0 Release note for CVE-2023-45809 in 4.1.9 2023-10-19 14:56:21 +01:00
..
_static Documentation - Fix missing links / images 2023-02-03 10:41:30 +00:00
_templates Update Algolia DocSearch integration with new application and correct versioning setup 2023-03-10 16:00:12 +00:00
advanced_topics Release note for #9935 in 4.1.x 2023-02-03 17:51:58 +00:00
contributing Move editor guide content to its own website 2022-10-28 13:00:10 +01:00
editor_manual Move editor guide content to its own website 2022-10-28 13:00:10 +01:00
extending Add ability to check permission on parent `PanelGroup` class 2022-10-18 09:53:13 +10:00
getting_started Add formal support for Python 3.11 2022-10-26 11:04:03 +01:00
public
reference Revert FieldRowPanel documentation removal, clarifying differences. Fix #10061 2023-03-14 22:46:13 +00:00
releases Release note for CVE-2023-45809 in 4.1.9 2023-10-19 14:56:21 +01:00
topics Clarify ClusterableModel requirements for using relations with RevisionMixin-enabled models 2023-03-13 09:42:23 +00:00
Makefile
README.md
autobuild.sh
conf.py Documentation - update package versions 2022-10-17 10:07:44 +01:00
favicon.ico
index.rst Update guide.wagtail.org links to point to v4.1.x pages 2023-02-03 10:42:53 +00:00
logo.png
requirements.txt Update Algolia DocSearch integration with new application and correct versioning setup 2023-03-10 16:00:12 +00:00
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.