mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-08-08 04:48:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
django/docs
History
Sarah Boyce ad836aa0c5 [5.2.x] Added stub release notes for 5.2.6. 
Backport of 0bff53b413 from main.
2025-08-06 10:36:46 +02: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 [5.2.x] Added Django ecosystem page to the documentation. 2025-07-13 15:06:58 +02:00
howto [5.2.x] Fixed #36252 -- Handled duplicate automatic imports in the shell command. 2025-03-17 16:30:31 -03:00
internals [5.2.x] Refs #36485 -- Grouped docs checks under a unified make check target. 2025-08-05 12:20:13 -03:00
intro [5.2.x] Moved manual testing instructions from intro to submitting patches docs. 2025-07-28 09:02:15 -03: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 #36530 -- Extended fields.E347 to check for ManyToManyField involving CompositePrimaryKey on either side. 2025-08-05 08:46:56 -03:00
releases [5.2.x] Added stub release notes for 5.2.6. 2025-08-06 10:36:46 +02:00
topics [5.2.x] Corrected assertNumQueries() example in docs/topics/testing/tools.txt. 2025-08-04 15:08:53 +02: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 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.2.x] Added accessibility guidelines for contributors. 2025-07-23 16:42:23 +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/