mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-07-07 21:35:15 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
django/docs
History
Exact
Sarah Boyce 97c753741a [5.1.x] Added follow-up to CVE-2025-48432 to security archive. 
Backport of 2714bc3f2c from main.
2025-06-10 15:15:14 +02:00
..
_ext [5.1.x] Fixed typo in source file linking Sphinx extension. 2024-07-01 11:33:45 -03:00
_theme Fixed docs build with sphinxcontrib-spelling 7.5.0+. 2022-05-31 11:17:01 +02:00
faq [5.1.x] Fixed #35908 -- Retired the django-developers and django-users mailing lists. 2025-02-19 12:18:12 +01:00
howto [5.1.x] Fixed #36200 -- Clarified MIDDLEWARE setting updates when using a custom RemoteUserMiddleware. 2025-02-20 16:16:29 +01:00
internals [5.1.x] Documented the updating of translation catalogs in post-release tasks. 2025-03-21 14:56:44 +01:00
intro [5.1.x] Fixed #36402, Refs #35980 -- Updated built package name in reusable apps tutorial for PEP 625. 2025-05-26 12:37:29 -03:00
man Updated man page for Django 5.1 alpha. 2024-05-22 11:29:45 -03:00
misc [5.1.x] Fixed #35908 -- Retired the django-developers and django-users mailing lists. 2025-02-19 12:18:12 +01:00
ref [5.1.x] Fixed #36213 -- Doc'd MySQL's handling of self-select updates in QuerySet.update(). 2025-04-02 08:48:02 +02:00
releases [5.1.x] Added follow-up to CVE-2025-48432 to security archive. 2025-06-10 15:15:14 +02:00
topics [5.1.x] Fixed typo in docs/topics/signals.txt. 2025-03-23 20:06:39 +01:00
conf.py [5.1.x] Fixed #36320 -- Ignored "duplicated_toc_entry" for ePub docs build. 2025-04-12 19:40:16 +02:00
contents.txt
glossary.txt
index.txt [5.1.x] Replaced usage of "patch" with more precise terms in faq, howto, and intro docs. 2024-06-09 14:40:18 -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 [5.1.x] Fixed #36162 -- Fixed the black Makefile docs rule to work on macOS. 2025-02-01 22:29:22 -03:00
README.rst Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 2020-01-29 06:04:15 +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 [5.1.x] Expanded contributor docs on getting feedback from the wider community. 2024-10-16 13:25:43 +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/