1
0
mirror of https://github.com/django/django.git synced 2024-12-25 02:26:12 +00:00
django/docs
David Smith 7f0275d8cb [5.0.x] Refs #32819 -- Used auto_id instead of id_for_label as unique identifier for the field.
`id_for_label` is blank for widgets with multiple inputs such as radios
and multiple checkboxes. Therefore , `help_text` for fields using these
widgets cannot currently be associated using `aria-describedby`.
`id_for_label` is being used as a guard to avoid incorrectly adding
`aria-describedby` to those widgets.

This change uses `auto_id` as the unique identified for the fields
`help_text`. A guard is added to avoid incorrectly adding
`aria-describedby` to inputs by checking the widget's `use_fieldset`
attribute. Fields rendered in a `<fieldset>` should have
`aria-describedby` added to the `<fieldset>` and not every `<input>`.

Backport of 292f1ea90f from main
2023-11-16 13:27:18 +01:00
..
_ext
_theme
faq
howto [5.0.x] Removed obsolete sentence in custom model field docs. 2023-11-15 13:49:17 +01:00
internals [5.0.x] Restructured writing documentation contributing guide. 2023-10-21 16:56:16 +02:00
intro
man
misc
ref [5.0.x] Refs #32819 -- Used auto_id instead of id_for_label as unique identifier for the field. 2023-11-16 13:27:18 +01:00
releases [5.0.x] Refs #32819 -- Used auto_id instead of id_for_label as unique identifier for the field. 2023-11-16 13:27:18 +01:00
topics [5.0.x] Refs #32819 -- Used auto_id instead of id_for_label as unique identifier for the field. 2023-11-16 13:27:18 +01:00
conf.py
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README.rst
requirements.txt
spelling_wordlist

The documentation in this tree is in plain text files and can be viewed using
any text file viewer.

It uses `ReST`_ (reStructuredText), and the `Sphinx`_ documentation system.
This allows it to be built into other forms for easier viewing and browsing.

To create an HTML version of the docs:

* Install Sphinx (using ``python -m pip install Sphinx`` or some other method).

* In this docs/ directory, type ``make html`` (or ``make.bat html`` on
  Windows) at a shell prompt.

The documentation in ``_build/html/index.html`` can then be viewed in a web
browser.

.. _ReST: https://docutils.sourceforge.io/rst.html
.. _Sphinx: https://www.sphinx-doc.org/