wagtail/docs
Thibaud Colas d7ccda33f6
Update sphinx-wagtail-theme and search implementation (#12521)
2024-11-01 09:35:43 +00:00
..
_static Update sphinx-wagtail-theme and search implementation (#12521) 2024-11-01 09:35:43 +00:00
_templates Update sphinx-wagtail-theme and search implementation (#12521) 2024-11-01 09:35:43 +00:00
advanced_topics Fix remaining XHTML errors in docs to remove ePub build errors 2024-10-31 07:52:49 +10:00
contributing Fix remaining XHTML errors in docs to remove ePub build errors 2024-10-31 07:52:49 +10:00
deployment Documentation - Update page titles to align with Style Guide 2024-10-27 15:27:03 +10:00
editor_manual Simplify Wagtail docs section titles 2024-09-19 10:09:46 +01:00
extending Doc - Fix minor spelling inconsistency 2024-10-29 15:47:39 +00:00
getting_started Increase DATA_UPLOAD_MAX_NUMBER_FIELDS in project template & docs 2024-10-28 08:27:29 +10:00
public
reference Docs - Ensure core models module level docstring does not appear in docs 2024-10-29 15:47:39 +00:00
releases Update changelog for 6.3 cherry-pick #12490 #12506 #12507 2024-10-31 08:12:48 +10:00
topics Fix remaining XHTML errors in docs to remove ePub build errors 2024-10-31 07:52:49 +10:00
tutorial ImageBlock for StreamField (rebase of #11791) (#12416) 2024-10-21 16:11:34 +01:00
Makefile Upgrade Sphinx to 7.3; use newer syntax for no-index directive and --fail-on-warning switch 2024-07-23 10:13:03 +01:00
README.md
conf.py Replace Torchbox with 'Wagtail core team and contributors' in docs config 2024-10-31 07:52:49 +10:00
favicon.ico Update all other Wagtail logos to the latest version 2024-03-23 19:48:31 +10:00
index.rst Rename deploy URL to deployment + update title 2024-09-19 10:09:46 +01:00
logo.png Update all other Wagtail logos to the latest version 2024-03-23 19:48:31 +10:00
spelling_wordlist.txt
support.md Replace X links with Mastodon (#12460) 2024-10-24 12:09:59 +01:00

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.