Joonas Häkkinen 87c5de3b7f Fixed #36200 -- Clarified MIDDLEWARE setting updates when using a custom RemoteUserMiddleware. 3 days ago
..
_ext 289f48c71b Fixed typo in source file linking Sphinx extension. 7 months ago
_theme ac90529cc5 Fixed docs build with sphinxcontrib-spelling 7.5.0+. 2 years ago
faq 86493307f9 Fixed #35908 -- Retired the django-developers and django-users mailing lists. 3 days ago
howto 87c5de3b7f Fixed #36200 -- Clarified MIDDLEWARE setting updates when using a custom RemoteUserMiddleware. 2 days ago
internals 86493307f9 Fixed #35908 -- Retired the django-developers and django-users mailing lists. 3 days ago
intro 86493307f9 Fixed #35908 -- Retired the django-developers and django-users mailing lists. 3 days ago
man 051acc5c48 Updated man page for Django 5.2 alpha. 1 month ago
misc 86493307f9 Fixed #35908 -- Retired the django-developers and django-users mailing lists. 3 days ago
ref 43766c70bd Clarified admonition in GeneratedField docs. 2 days ago
releases 65c46d6932 Fixed #35358, Refs #35234 -- Renamed _check() methods to check() for constraints. 3 days ago
topics 65c46d6932 Fixed #35358, Refs #35234 -- Renamed _check() methods to check() for constraints. 3 days ago
Makefile 248d8457cb Fixed #36162 -- Fixed the `black` Makefile docs rule to work on macOS. 2 weeks ago
README.rst 32166a9f7c Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 5 years ago
conf.py 2684a383bc Fixed docs build on Sphinx 8.2+. 3 days ago
contents.txt bca9faae95 Fixed #26020 -- Normalized header stylings in docs. 9 years ago
glossary.txt bca9faae95 Fixed #26020 -- Normalized header stylings in docs. 9 years ago
index.txt 85240139ca Replaced usage of "patch" with more precise terms in faq, howto, and intro docs. 8 months ago
make.bat 6015bab80e Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2 years ago
requirements.txt 6015bab80e Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2 years ago
spelling_wordlist 6f6b261c3e Removed unused and unnecessary words from docs/spelling_wordlist. 2 months ago

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/