wagtail/docs
SebCorbin 83f00a8363 Capfirst should be used on model verbose name instead of title (#12358) 2024-09-25 17:13:21 +01:00
..
_static doc: fix pdf export (#12076) 2024-07-19 01:27:07 +01:00
_templates Extend the until date of the promotion banner for Wagtail Space 2024-06-13 15:16:29 +02:00
advanced_topics Added example for customizing a default accessibility check (#12267) 2024-09-24 11:00:20 +01:00
contributing Simplify Wagtail docs section titles 2024-09-19 10:09:46 +01:00
deployment Rename deploy URL to deployment + update title 2024-09-19 10:09:46 +01:00
editor_manual Simplify Wagtail docs section titles 2024-09-19 10:09:46 +01:00
extending Simplify Wagtail docs section titles 2024-09-19 10:09:46 +01:00
getting_started Align recent docs & release notes to US spelling 2024-08-29 18:28:07 +01:00
public Move security.txt to wagtail.org (#9751) 2023-04-21 18:01:09 +01:00
reference Update `WAGTAIL_WORKFLOW_REQUIRE_REAPPROVAL_ON_EDIT` docs to indicate that default is False (#12340) 2024-09-19 16:41:17 +01:00
releases Capfirst should be used on model verbose name instead of title (#12358) 2024-09-25 17:13:21 +01:00
topics Documentation - formatting clean up 2024-08-29 18:32:20 +01:00
tutorial Rename deploy URL to deployment + update title 2024-09-19 10:09:46 +01:00
Makefile Upgrade Sphinx to 7.3; use newer syntax for no-index directive and --fail-on-warning switch 2024-07-23 10:13:03 +01:00
README.md Resolve multiple typos (spelling and grammar) 2023-05-30 21:07:37 +10:00
conf.py doc: fix pdf export (#12076) 2024-07-19 01:27:07 +01:00
favicon.ico Update all other Wagtail logos to the latest version 2024-03-23 19:48:31 +10:00
index.rst Rename deploy URL to deployment + update title 2024-09-19 10:09:46 +01:00
logo.png Update all other Wagtail logos to the latest version 2024-03-23 19:48:31 +10:00
spelling_wordlist.txt Resolve multiple typos (spelling and grammar) 2023-05-30 21:07:37 +10:00
support.md Update twitter link in support docs to x.com (#12205) 2024-08-05 13:54:37 +01:00

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.