django/docs
Simon Charette c8b6594305 Fixed #32632, Fixed #32657 -- Removed flawed support for Subquery deconstruction.
Subquery deconstruction support required implementing complex and
expensive equality rules for sql.Query objects for little benefit as
the latter cannot themselves be made deconstructible to their reference
to model classes.

Making Expression @deconstructible and not BaseExpression allows
interested parties to conform to the "expression" API even if they are
not deconstructible as it's only a requirement for expressions allowed
in Model fields and meta options (e.g. constraints, indexes).

Thanks Phillip Cutter for the report.

This also fixes a performance regression in bbf141bcdc.
2021-04-28 12:13:55 +02:00
..
_ext Made default_role_error use logger. 2020-06-03 11:42:42 +02:00
_theme Fixed #16300 -- Improved singlehtml docs formatting with headers CSS. 2020-06-22 21:05:13 +02:00
faq Fixed #32652 -- Fixed links to new contributors FAQ. 2021-04-15 17:14:22 +02:00
howto Fixed #32667 -- Added link to labeling checks in BaseCommand.requires_system_checks docs. 2021-04-21 16:40:04 +02:00
internals Added note to update docs config when creating new stable branch. 2021-04-22 08:08:38 +02:00
intro Refs #28034 -- Corrected docs example in contributing tutorial. 2021-04-23 15:24:16 +02:00
man Updated django-admin man page for Django 3.2. 2021-01-14 14:58:28 +01:00
misc Expanded API stability docs to include our policy of continual improvement. 2019-11-18 20:37:46 +01:00
ref Refs #32682 -- Renamed use_distinct variable to may_have_duplicates. 2021-04-27 10:34:47 +02:00
releases Fixed #32632, Fixed #32657 -- Removed flawed support for Subquery deconstruction. 2021-04-28 12:13:55 +02:00
topics Fixed #32667 -- Added link to labeling checks in BaseCommand.requires_system_checks docs. 2021-04-21 16:40:04 +02:00
Makefile Fixed docs build with Sphinx 1.6. 2017-05-24 09:13:26 -04:00
README.rst Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 2020-01-29 06:04:15 +01:00
conf.py Updated Git branch "master" to "main". 2021-03-09 08:48:32 +01:00
contents.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
glossary.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
index.txt Fixed #25712 -- Reorganized templates docs. 2020-04-30 08:12:09 +02:00
make.bat
requirements.txt Used GitHub actions for docs tests. 2021-02-26 22:12:25 +01:00
spelling_wordlist Fixed #31840 -- Added support for Cross-Origin Opener Policy header. 2021-03-30 19:59:24 +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/