django/docs
Carlton Gibson 5df512e53a Simplified Intersphinx configuration example.
docs.djangoproject.com had been updated to serve the object.inv file
from the default location, so the second tuple element can be None
(the "default" value).
2025-03-28 09:36:13 +01:00
..
_ext Fixed typo in source file linking Sphinx extension. 2024-07-01 11:32:48 -03:00
_theme
faq Fixed #35908 -- Retired the django-developers and django-users mailing lists. 2025-02-19 12:14:27 +01:00
howto Fixed #36252 -- Handled duplicate automatic imports in the shell command. 2025-03-17 16:29:28 -03:00
internals Fixed #35452 -- Deprecated orphans being more than or equal to page_size in pagination. 2025-03-25 12:04:13 +01:00
intro Simplified Intersphinx configuration example. 2025-03-28 09:36:13 +01:00
man Updated man page for Django 5.2 alpha. 2025-01-15 21:11:20 +01:00
misc Fixed #35908 -- Retired the django-developers and django-users mailing lists. 2025-02-19 12:14:27 +01:00
ref Fixed #34917 -- Underlined links in the main content area of the admin. 2025-03-27 13:27:33 +01:00
releases Fixed #35440 -- Simplified parse_header_parameters by leveraging stdlid's Message. 2025-03-27 08:57:03 -03:00
topics Fixed typo in docs/topics/signals.txt. 2025-03-23 20:02:42 +01:00
conf.py Fixed docs build on Sphinx 8.2+. 2025-02-19 09:44:53 +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 Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
Makefile Fixed #36162 -- Fixed the black Makefile docs rule to work on macOS. 2025-02-01 22:27:38 -03:00
README.rst
requirements.txt Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
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/