wagtail/docs
LB Johnston bda0c45a40 6.0 changelog/release notes fixes
- Fix various typos and grammar issues
- Use consistent approach to version updates & class-based (not class based) view naming
- Fix a malformed link for upgrade considerations
2024-01-26 09:43:19 +00:00
..
_static Move accessibility checker inside the editor (#11478). Fix #10136 2024-01-23 08:15:34 +00:00
_templates Bump djhtml to 3.0.6 (#11158) 2023-10-31 10:11:02 +00:00
advanced_topics 6.0 release - Add versionadded sections & release notes links 2024-01-24 13:54:48 +00:00
contributing Formatting documentation for whitespace fixes 2024-01-21 19:59:57 +10:00
editor_manual Move editor guide content to its own website 2022-10-28 10:16:32 +01:00
extending 6.0 release - Add versionadded sections & release notes links 2024-01-24 13:54:48 +00:00
getting_started Update Django intersphinx references to new format 2024-01-21 10:09:21 +10:00
public Move security.txt to wagtail.org (#9751) 2023-04-21 18:01:09 +01:00
reference 6.0 release - Add versionadded sections & release notes links 2024-01-24 13:54:48 +00:00
releases 6.0 changelog/release notes fixes 2024-01-26 09:43:19 +00:00
topics 6.0 release - Add versionadded sections & release notes links 2024-01-24 13:54:48 +00:00
tutorial Formatting documentation for whitespace fixes 2024-01-21 19:59:57 +10:00
Makefile Flags added to convert doc build warnings to errors 2024-01-24 10:42:51 +10:00
README.md Resolve multiple typos (spelling and grammar) 2023-05-30 21:07:37 +10:00
autobuild.sh
conf.py Add myst_url_schemes config for external links 2024-01-21 10:09:21 +10:00
favicon.ico
index.rst Rename "advanced tutorial" to "full tutorial" (#11260) 2023-11-20 15:22:52 +00:00
logo.png
spelling_wordlist.txt Resolve multiple typos (spelling and grammar) 2023-05-30 21:07:37 +10:00
support.md Remove mention of Wagtail Google group 2023-12-15 11:29:45 +00: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.