mirror of
https://github.com/wagtail/wagtail.git
synced 2024-11-25 05:02:57 +01:00
443ccb23a8
It's MyST syntax, not rST, so it's OK to use it (sparingly). Custom admonitions are possible with the `admonition` directive. |
||
|---|---|---|
| .. | ||
| _static | ||
| _templates | ||
| advanced_topics | ||
| contributing | ||
| deployment | ||
| editor_manual | ||
| extending | ||
| getting_started | ||
| public | ||
| reference | ||
| releases | ||
| topics | ||
| tutorial | ||
| conf.py | ||
| favicon.ico | ||
| index.rst | ||
| logo.png | ||
| Makefile | ||
| README.md | ||
| spelling_wordlist.txt | ||
| support.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.