0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 17:36:49 +01:00
wagtail/docs
2023-07-12 09:18:11 +01:00
..
_static
_templates
advanced_topics
contributing
editor_manual
extending Implement new Draftail customisation APIs 2023-07-06 13:14:54 +10:00
getting_started Switch the tutorial snippets example to be more understandable #10609 (#10624) 2023-07-03 16:54:49 +01:00
public
reference Allow customising the spreadsheet file name via SnippetViewSet.export_filename 2023-07-12 09:18:11 +01:00
releases Fix incorrect override of PagePermissionHelper.user_can_unpublish_obj() in ModelAdmin 2023-07-07 16:35:46 +01:00
topics Allow customising the spreadsheet file name via SnippetViewSet.export_filename 2023-07-12 09:18:11 +01:00
autobuild.sh
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.