Sage Abdullah ddf8423f3c Use stable link to Wand docs 4 months ago
..
_static d7ccda33f6 Update sphinx-wagtail-theme and search implementation (#12521) 5 months ago
_templates d7ccda33f6 Update sphinx-wagtail-theme and search implementation (#12521) 5 months ago
advanced_topics ddf8423f3c Use stable link to Wand docs 4 months ago
contributing 503d1a743a Replace hardcoded Python docs links with intersphinx 4 months ago
deployment 857b26e5a0 Replace hardcoded Django docs links to intersphinx links 4 months ago
editor_manual 8b3540de0d Simplify Wagtail docs section titles 6 months ago
extending 503d1a743a Replace hardcoded Python docs links with intersphinx 4 months ago
getting_started 503d1a743a Replace hardcoded Python docs links with intersphinx 4 months ago
public a2e1becc49 Move security.txt to wagtail.org (#9751) 1 year ago
reference 503d1a743a Replace hardcoded Python docs links with intersphinx 4 months ago
releases 9a5be8f180 Replace more hardcoded Django links with intersphinx in rST docs 4 months ago
topics 857b26e5a0 Replace hardcoded Django docs links to intersphinx links 4 months ago
tutorial 0913118da4 Replaced Twitter references in the docs with more appropriate alternatives (#12516). Fix #12483 5 months ago
Makefile f7fa20e600 Upgrade Sphinx to 7.3; use newer syntax for no-index directive and --fail-on-warning switch 8 months ago
README.md aa9e9cddc7 Resolve multiple typos (spelling and grammar) 1 year ago
conf.py 503d1a743a Replace hardcoded Python docs links with intersphinx 4 months ago
favicon.ico e9593e7b6b Update all other Wagtail logos to the latest version 1 year ago
index.rst 8f215bda5f Rename deploy URL to deployment + update title 6 months ago
logo.png e9593e7b6b Update all other Wagtail logos to the latest version 1 year ago
spelling_wordlist.txt aa9e9cddc7 Resolve multiple typos (spelling and grammar) 1 year ago
support.md e4e94a5640 Replace X links with Mastodon (#12460) 5 months ago

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.