Back to Wagtail

Wagtail docs

docs/README.md

7.3.11.1 KB
Original Source

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):

sh
pip install -e .[testing,docs] --config-settings editable-mode=strict

To build the documentation for browsing, from this directory run:

On Linux / macOS:

sh
make html

On Windows:

python -m sphinx . _build/html

then open _build/html/index.html in a browser.

To rebuild automatically while editing the documentation, from this directory run:

sphinx-autobuild . _build/html

On Windows, if the command above is not found, try

python -m sphinx_autobuild . _build/html

The online MyST playground at Curvenote or the MyST-Markdown VS Code Extension are helpful tools for working with the MyST syntax.