wagtail/docs
Vince Salvino 9545193907 Add official hosting documentation
- Create a deploy section of the documentation
- Move fly.io deployment from tutorial to it's own page under deploy
- Clean up deployment docs and references throughout documentation
2024-09-03 07:59:20 +10:00
..
_static
_templates
advanced_topics Add official hosting documentation 2024-09-03 07:59:20 +10:00
contributing Change Twitter to X in security.md 2024-08-27 15:32:17 +01:00
deploy Add official hosting documentation 2024-09-03 07:59:20 +10:00
editor_manual
extending Align recent docs & release notes to US spelling 2024-08-29 18:28:07 +01:00
getting_started Align recent docs & release notes to US spelling 2024-08-29 18:28:07 +01:00
public
reference Documentation - formatting clean up 2024-08-29 18:32:20 +01:00
releases Add official hosting documentation 2024-09-03 07:59:20 +10:00
topics Documentation - formatting clean up 2024-08-29 18:32:20 +01:00
tutorial Add official hosting documentation 2024-09-03 07:59:20 +10:00
Makefile
README.md
conf.py
favicon.ico
index.rst Add official hosting documentation 2024-09-03 07:59:20 +10:00
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]

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.