wagtail/docs
sag᠎e ed36b5b9b6
Improve customisability of the accessibility checker configuration. Fix #10137 (#10333)
* Extract userbar BaseItem.get_context_data()
* Extract Axe config into smaller attributes and methods for easier overrides
* Add TypeScript interface for WagtailAxeConfiguration
* Improve typings for userbar.ts
* Separate Axe `runOnly` and `rules` options
* Pass request object to all axe configuration methods
* Remove Axe runOnly option if it's falsy
* Add docs for customising the accessibility checker
* Use lists for Axe include and exclude selectors
* Parse JSON script when testing accessibility checker config
* Add tests for customising accessibility checker configuration

Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2023-04-20 07:46:56 +01:00
..
_static Add decimal and regex icons 2023-04-18 02:49:04 +01:00
_templates Update Algolia DocSearch integration with new application and correct versioning setup 2023-03-10 15:57:17 +00:00
advanced_topics Improve customisability of the accessibility checker configuration. Fix #10137 (#10333) 2023-04-20 07:46:56 +01:00
contributing Update number of tests 2023-04-18 18:14:48 +10:00
editor_manual Move editor guide content to its own website 2022-10-28 10:16:32 +01:00
extending Update documentation referring to icon class names 2023-04-12 11:51:00 +01:00
getting_started Formalise support for Django 4.2 2023-04-03 17:14:29 +02:00
public Add a security.txt file 2022-09-06 08:09:30 +10:00
reference Improve customisability of the accessibility checker configuration. Fix #10137 (#10333) 2023-04-20 07:46:56 +01:00
releases Improve customisability of the accessibility checker configuration. Fix #10137 (#10333) 2023-04-20 07:46:56 +01:00
topics Improve customisability of the accessibility checker configuration. Fix #10137 (#10333) 2023-04-20 07:46:56 +01:00
Makefile Fix broken "make livehtml" command 2021-02-04 11:55:02 -08:00
README.md Documentation - update dead/redirected links 2022-10-11 20:44:08 +10:00
autobuild.sh [skip ci] added commment about autobuild inside vms (#3379) 2017-02-16 21:29:10 +00:00
conf.py Documentation - update package versions 2022-10-17 10:07:44 +01:00
favicon.ico add favicon to documentation 2018-03-08 12:24:13 +00:00
index.rst Re-add editor guide link (#9539) 2022-10-28 15:42:04 +01:00
logo.png
requirements.txt Update Algolia DocSearch integration with new application and correct versioning setup 2023-03-10 15:57:17 +00:00
spelling_wordlist.txt Add more names and jargon to spelling wordlist 2020-10-03 14:43:03 +01:00
support.md Documentation - clean up small typos and whitespace issues 2022-10-13 22:41:33 +10: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.