mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-10-21 12:49:11 +00:00
Code Issues 32 Releases Wiki Activity
django/docs
History
Natalia 953163e610 [6.0.x] Fixed #36526 -- Doc'd QuerySet.bulk_update() memory usage when batching. 
Thanks Simon Charette for the review.

Backport of 608d3ebc8889863d43be1090d634b9507fe4a85e from main.
2025-10-08 18:27:56 -03: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
[6.0.x] Added backticks to email addresses in docs.
2025-09-17 22:24:37 +02:00
howto
[6.0.x] Fixed #35877, Refs #36128 -- Documented unique constraint when migrating a m2m field to use a through model.
2025-09-29 08:59:15 +02:00
internals
[6.0.x] Clarified feature freeze and alpha release steps in docs/internals/howto-release-django.txt.
2025-09-18 22:08:35 -03:00
intro
[6.0.x] Fixed #35961 -- Migrated license metadata in pyproject.toml to conform PEP 639.
2025-10-08 16:40:43 -03:00
man
Updated man page for Django 6.0 alpha 1.
2025-09-17 14:20:40 -03:00
misc
Refs #36485 -- Rewrapped docs to 79 columns line length.
2025-08-25 10:51:10 -03:00
ref
[6.0.x] Fixed #36526 -- Doc'd QuerySet.bulk_update() memory usage when batching.
2025-10-08 18:27:56 -03:00
releases
[6.0.x] Rewrapped security archive at 79 chars.
2025-10-01 16:24:50 -04:00
topics
[6.0.x] Fixed #36636, Refs #15902 -- Removed session-based storage reference from set_language() docs.
2025-10-03 15:17:27 -04:00
conf.py
[6.0.x] Bumped django_next_version in docs config.
2025-09-17 14:54:41 -03:00
contents.txt
Ensured :doc: role uses absolute targets in docs.
2025-08-28 13:48:32 -03:00
glossary.txt
Refs #36485 -- Rewrapped docs to 79 columns line length.
2025-08-25 10:51:10 -03:00
index.txt
[6.0.x] Refs #35859 -- Mentioned tasks in the docs index.
2025-09-24 09:48:14 +02:00
lint.py
Refs #36485 -- Corrected docs linter to detect too-long lines at file end.
2025-08-29 17:35:50 -04:00
make.bat
Fixed #36485 -- Added lint-docs check in Tox and GitHub Actions.
2025-08-25 10:51:10 -03:00
Makefile
Fixed #36485 -- Added lint-docs check in Tox and GitHub Actions.
2025-08-25 10:51:10 -03:00
README.rst
Refs #25778 -- Updated sphinx-doc.org links to HTTPS.
2020-01-29 06:04:15 +01:00
requirements.txt
Refs #36485 -- Added sphinx-lint support and make lint rule for docs.
2025-08-25 10:51:10 -03:00
spelling_wordlist
Fixed #35859 -- Added background Tasks framework interface.
2025-09-16 17:28:32 -03: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/