Thibaud Colas 23cf9762df Update tutorial screenshots for Wagtail v5.1 1 anno fa
..
_static 23cf9762df Update tutorial screenshots for Wagtail v5.1 1 anno fa
_templates d5e4ac5590 Update Algolia DocSearch integration with new application and correct versioning setup 2 anni fa
advanced_topics 69724e4e3a Create preview-aware & page-enhanced cache template tags 1 anno fa
contributing d05c0c1bc1 Update docs to cover Elasticsearch 8 support 1 anno fa
editor_manual 42f5ea1fc8 Move editor guide content to its own website 2 anni fa
extending f4ea0156a2 Implement new Draftail customisation APIs 1 anno fa
getting_started 3d471edbcf Clean whitespace formatting in docs 1 anno fa
public a2e1becc49 Move security.txt to wagtail.org (#9751) 1 anno fa
reference fad37fd232 Add docs for migrating from modeladmin to snippets 1 anno fa
releases cc2a6bcc02 Move permissions consolidation and snippet enhancements to their own release notes sections 1 anno fa
topics fad37fd232 Add docs for migrating from modeladmin to snippets 1 anno fa
Makefile fdf1597263 Fix broken "make livehtml" command 4 anni fa
README.md aa9e9cddc7 Resolve multiple typos (spelling and grammar) 1 anno fa
autobuild.sh c239932434 [skip ci] added commment about autobuild inside vms (#3379) 8 anni fa
conf.py ac10b36c7b Run pyupgrade with `--py38-plus` 1 anno fa
favicon.ico e2f2a8c005 add favicon to documentation 7 anni fa
index.rst 939b14b33c Move snippets.md docs to its own directory 1 anno fa
logo.png 82171f70fa reduced size of logo 9 anni fa
spelling_wordlist.txt aa9e9cddc7 Resolve multiple typos (spelling and grammar) 1 anno fa
support.md aa9e9cddc7 Resolve multiple typos (spelling and grammar) 1 anno fa

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.