django/docs
David Smith 292f1ea90f 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>`.
2023-11-16 12:23:42 +01:00
..
_ext Fixed #34756 -- Fixed docs HTML build on Sphinx 7.1+. 2023-08-03 08:01:06 +02:00
_theme Fixed docs build with sphinxcontrib-spelling 7.5.0+. 2022-05-31 11:17:01 +02:00
faq Added stub release notes for 5.1. 2023-09-18 22:12:40 +02:00
howto Removed obsolete sentence in custom model field docs. 2023-11-15 13:48:45 +01:00
internals Fixed #34462 -- Made admin log actions in bulk. 2023-10-31 18:06:44 +01:00
intro Reorganized tutorial's part 4 to better understand changes needed in URLConf. 2023-10-10 10:49:27 -03:00
man Updated man page for Django 5.0 alpha. 2023-09-18 09:25:34 -03:00
misc Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate. 2021-07-29 06:24:12 +02:00
ref Refs #32819 -- Used auto_id instead of id_for_label as unique identifier for the field. 2023-11-16 12:23:42 +01:00
releases Refs #32819 -- Used auto_id instead of id_for_label as unique identifier for the field. 2023-11-16 12:23:42 +01:00
topics Refs #32819 -- Used auto_id instead of id_for_label as unique identifier for the field. 2023-11-16 12:23:42 +01:00
Makefile Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
README.rst Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 2020-01-29 06:04:15 +01:00
conf.py Bumped version; main is now 5.1 pre-alpha. 2023-09-18 22:12:40 +02:00
contents.txt
glossary.txt
index.txt Added Django Forum to mailing lists page. 2023-03-24 08:32:17 +01:00
make.bat Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
requirements.txt Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
spelling_wordlist Added Uyghur language. 2023-08-12 20:37:15 +02:00

README.rst

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/