wagtail/docs
Sage Abdullah ca7e9bd65a
Update editable installation instruction to use editable_mode=strict
Avoid "module not found" errors on VSCode
https://microsoft.github.io/pyright/#/import-resolution?id=editable-installs
2025-04-10 10:30:33 +07:00
..
_static
_templates
advanced_topics Document snippets requirement for features provided by model mixins (#12999) 2025-04-09 15:50:49 +01:00
contributing Update editable installation instruction to use editable_mode=strict 2025-04-10 10:30:33 +07:00
deployment
editor_manual
extending
getting_started Formalize support for Django 5.2 2025-04-03 20:33:55 +01:00
public
reference Document snippets requirement for features provided by model mixins (#12999) 2025-04-09 15:50:49 +01:00
releases Add missing apps.py file (#13001) 2025-04-09 19:19:15 +01:00
topics Fix typo in preview blocks documentation 2025-03-24 10:01:52 +01:00
tutorial
Makefile Update doc8 to latest 2025-04-10 10:30:32 +07:00
README.md Update editable installation instruction to use editable_mode=strict 2025-04-10 10:30:33 +07:00
conf.py
favicon.ico
index.rst
logo.png
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] --config-settings editable-mode=strict

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.