0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs
Storm B. Heg 2c43ddbbd3 Add support for options/attrs in Telepath widgets & add required/aria-describedby
- This allows us to pass extra data for the widget to use in a backwards-compatible way.
- FieldBlock: render 'required' and 'aria-describedby' attributes when appropriate
- Ensure options passed to `render` override defaults
- FieldBlock: add test proving options are constructed and passed down
- Allow Telepath's widget rendering to take options
- Include extra accessibility-related attributes in html output
- Resolves missing required attribute on input elements for required fields
- Resolves missing aria-describedby attribute on input element when the field has help text.
- Partial work on #10300
2023-08-05 08:55:53 +10:00
..
_static Update tutorial screenshots for Wagtail v5.1 2023-08-01 13:15:08 +01:00
_templates Update Algolia DocSearch integration with new application and correct versioning setup 2023-03-10 15:57:17 +00:00
advanced_topics Create preview-aware & page-enhanced cache template tags 2023-07-20 08:24:09 +10:00
contributing Update docs to cover Elasticsearch 8 support 2023-07-17 16:18:37 +01:00
editor_manual Move editor guide content to its own website 2022-10-28 10:16:32 +01:00
extending Implement new Draftail customisation APIs 2023-07-06 13:14:54 +10:00
getting_started Clean whitespace formatting in docs 2023-07-17 22:24:54 +10:00
public Move security.txt to wagtail.org (#9751) 2023-04-21 18:01:09 +01:00
reference Add docs for migrating from modeladmin to snippets 2023-07-26 16:04:35 +01:00
releases Add support for options/attrs in Telepath widgets & add required/aria-describedby 2023-08-05 08:55:53 +10:00
topics Add docs for migrating from modeladmin to snippets 2023-07-26 16:04:35 +01:00
autobuild.sh
conf.py Run pyupgrade with --py38-plus 2023-07-14 13:06:41 +01:00
favicon.ico
index.rst Move snippets.md docs to its own directory 2023-05-24 11:06:00 +01:00
logo.png
Makefile
README.md Resolve multiple typos (spelling and grammar) 2023-05-30 21:07:37 +10:00
spelling_wordlist.txt Resolve multiple typos (spelling and grammar) 2023-05-30 21:07:37 +10:00
support.md Resolve multiple typos (spelling and grammar) 2023-05-30 21:07:37 +10:00

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.