django/docs
2025-03-17 16:30:31 -03:00
..
_ext Fixed typo in source file linking Sphinx extension. 2024-07-01 11:32:48 -03:00
_theme
faq [5.2.x] Fixed #35908 -- Retired the django-developers and django-users mailing lists. 2025-02-19 12:16:20 +01: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] Added security guideline on reasonable size limitations when rendering content via the DTL. 2025-02-24 08:54:44 +01:00
intro [5.2.x] Fixed incorrect formatting for inline pluralized code references in docs. 2025-03-13 15:23:55 -03:00
man [5.2.x] Updated man page for Django 5.2 beta. 2025-02-19 11:43:27 +01: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 pronoun disagreement in docs/ref/models/querysets.txt. 2025-03-14 10:49:28 +01:00
releases [5.2.x] Fixed #36234 -- Restored single_object argument to LogEntry.objects.log_actions(). 2025-03-12 16:36:48 -03:00
topics [5.2.x] Fixed #36254 -- Fixed template dictionary unpacking in docs/topics/i18n/timezones.txt. 2025-03-17 09:47:46 +01:00
conf.py [5.2.x] Fixed docs build on Sphinx 8.2+. 2025-02-19 09:46:18 +01: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
Makefile [5.2.x] Fixed #36162 -- Fixed the black Makefile docs rule to work on macOS. 2025-02-01 22:28:35 -03:00
README.rst
requirements.txt
spelling_wordlist Removed unused and unnecessary words from docs/spelling_wordlist. 2024-12-09 09:34:18 +01: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/