wagtail/docs
Sage Abdullah b8a7ad04a6
Release notes for #10592
2023-06-26 11:15:40 +01:00
..
_static Update documentation for color customisations 2023-06-12 10:55:12 +01:00
_templates
advanced_topics Documentation - clean up last two internal refs to use underscore 2023-06-19 15:18:02 +01:00
contributing Docs - update Django urls to shorthand method 2023-06-01 16:50:03 +01:00
editor_manual
extending Add ordering for group editor object permissions 2023-06-22 08:11:04 +10:00
getting_started Move the tutorial’s snippets section before tags 2023-06-23 15:37:58 +01:00
public Move security.txt to wagtail.org (#9751) 2023-04-21 18:01:09 +01:00
reference Release note / upgrade consideration for TitlefieldPanel #10568 2023-06-20 13:03:03 +01:00
releases Release notes for #10592 2023-06-26 11:15:40 +01:00
topics Documentation - clean up last two internal refs to use underscore 2023-06-19 15:18:02 +01:00
Makefile
README.md Resolve multiple typos (spelling and grammar) 2023-05-30 21:07:37 +10:00
autobuild.sh
conf.py
favicon.ico
index.rst Move snippets.md docs to its own directory 2023-05-24 11:06:00 +01:00
logo.png
spelling_wordlist.txt Resolve multiple typos (spelling and grammar) 2023-05-30 21:07:37 +10:00
support.md Resolve multiple typos (spelling and grammar) 2023-05-30 21:07:37 +10: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.