django/docs
Jacob Walls fe3db5bcbb [5.2.x] Added GitHub Actions linter (zizmor).
At the direction of the Security Team. Thanks Markus Holtermann,
Jake Howard, and Natalia Bidart for reviews.

Backport of 09d4bf5cd9 from main.
2025-11-21 14:43:27 -05:00
..
_ext Fixed typo in source file linking Sphinx extension. 2024-07-01 11:32:48 -03:00
_theme
faq [5.2.x] Refs #35844 -- Doc'd Python 3.14 compatibility. 2025-10-17 20:05:19 +02:00
howto [5.2.x] Refs #35844 -- Doc'd Python 3.14 compatibility. 2025-10-17 20:05:19 +02:00
internals [5.2.x] Added GitHub Actions linter (zizmor). 2025-11-21 14:43:27 -05:00
intro [5.2.x] Refs #35844 -- Doc'd Python 3.14 compatibility. 2025-10-17 20:05:19 +02:00
man [5.2.x] Updated man page for Django 5.2 final. 2025-04-02 14:47:20 +02:00
misc [5.2.x] Fixed #35908 -- Retired the django-developers and django-users mailing lists. 2025-02-19 12:16:20 +01:00
ref [5.2.x] Fixed #36686 -- Clarified Meta.ordering is ignored in GROUP BY queries. 2025-11-13 11:19:25 -05:00
releases [5.2.x] Added missing ticket links in docs/releases/5.2.8.txt. 2025-11-20 17:32:20 -05:00
topics [5.2.x] Fixed #36686 -- Clarified Meta.ordering is ignored in GROUP BY queries. 2025-11-13 11:19:25 -05:00
conf.py [5.2.x] Fixed #36320 -- Ignored "duplicated_toc_entry" for ePub docs build. 2025-04-12 19:39:32 +02: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 [5.2.x] Refs #36485 -- Grouped docs checks under a unified make check target. 2025-08-05 12:20:13 -03:00
Makefile [5.2.x] Refs #36485 -- Grouped docs checks under a unified make check target. 2025-08-05 12:20:13 -03:00
README.rst
requirements.txt
spelling_wordlist [5.2.x] Added accessibility guidelines for contributors. 2025-07-23 16:42:23 +02: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/