django/docs
Simon Charette ab148c02ce Fixed #33579 -- Specialized exception raised on forced update failures.
Raising DatabaseError directly made it harder than it should to
differentiate between IntegrityError when a forced update resulted in no
affected rows.

Introducing a specialized exception allows for callers to more easily
silence, log, or turn them update failures into user facing exceptions
(e.g. 404s).

Thanks Mariusz for the review.
2025-03-10 21:09:15 +01:00
..
_ext Fixed typo in source file linking Sphinx extension. 2024-07-01 11:32:48 -03:00
_theme Fixed docs build with sphinxcontrib-spelling 7.5.0+. 2022-05-31 11:17:01 +02:00
faq Fixed #35908 -- Retired the django-developers and django-users mailing lists. 2025-02-19 12:14:27 +01:00
howto Fixed #36200 -- Clarified MIDDLEWARE setting updates when using a custom RemoteUserMiddleware. 2025-02-20 16:12:28 +01:00
internals Refs #35444 -- Deprecated contrib.postgres.OrderableAggMixin. 2025-03-03 11:37:00 +01:00
intro Fixed #35908 -- Retired the django-developers and django-users mailing lists. 2025-02-19 12:14:27 +01:00
man Updated man page for Django 5.2 alpha. 2025-01-15 21:11:20 +01:00
misc Fixed #35908 -- Retired the django-developers and django-users mailing lists. 2025-02-19 12:14:27 +01:00
ref Fixed #33579 -- Specialized exception raised on forced update failures. 2025-03-10 21:09:15 +01:00
releases Fixed #33579 -- Specialized exception raised on forced update failures. 2025-03-10 21:09:15 +01:00
topics Fixed #36128 -- Clarified auto-generated unique constraint on m2m through models. 2025-03-04 13:06:09 +01:00
conf.py Fixed docs build on Sphinx 8.2+. 2025-02-19 09:44:53 +01:00
contents.txt
glossary.txt
index.txt Replaced usage of "patch" with more precise terms in faq, howto, and intro docs. 2024-06-09 14:38:04 -03:00
make.bat Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
Makefile Fixed #36162 -- Fixed the black Makefile docs rule to work on macOS. 2025-02-01 22:27:38 -03:00
README.rst
requirements.txt Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
spelling_wordlist Removed unused and unnecessary words from docs/spelling_wordlist. 2024-12-09 09:34:18 +01:00

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/