django/docs
Simon Charette 9a461cae3e [5.1.x] Fixed #35666 -- Documented stacklevel usage and testing, and adjusted test suite accordingly.
Over the years we've had multiple instances of hit and misses when
emitting warnings: either setting the wrong stacklevel or not setting
it at all.

This work adds assertions for the existing warnings that were declaring
the correct stacklevel, but were lacking tests for it.

Backport of 57307bbc7d from main.
2024-08-28 11:47:15 -03:00
..
_ext [5.1.x] Fixed typo in source file linking Sphinx extension. 2024-07-01 11:33:45 -03:00
_theme Fixed docs build with sphinxcontrib-spelling 7.5.0+. 2022-05-31 11:17:01 +02:00
faq [5.1.x] Added references to the Django Discord server inside the FAQ docs. 2024-06-26 12:39:25 +02:00
howto [5.1.x] Refs #35591 -- Emphasized that runserver is not suitable for production. 2024-08-08 10:10:29 +02:00
internals [5.1.x] Fixed #35666 -- Documented stacklevel usage and testing, and adjusted test suite accordingly. 2024-08-28 11:47:15 -03:00
intro [5.1.x] Used :pypi: role in docs where appropriate. 2024-08-05 10:36:41 -03:00
man Updated man page for Django 5.1 alpha. 2024-05-22 11:29:45 -03:00
misc Removed mention of designers in DTL design philosophy. 2024-02-01 09:20:11 +01:00
ref [5.1.x] Fixed typo in docs/ref/models/expressions.txt. 2024-08-28 09:09:16 -03:00
releases [5.1.x] Refs #35405 -- Adjusted deprecation warning stacklevel in FieldCacheMixin.get_cache_name(). 2024-08-28 11:46:49 -03:00
topics [5.1.x] Sorted alphabetically forms list in docs/topics/auth/default.txt. 2024-08-22 09:15:28 -03:00
conf.py [5.1.x] Bumped django_next_version in docs config. 2024-05-22 11:34:04 -03:00
contents.txt
glossary.txt
index.txt [5.1.x] Replaced usage of "patch" with more precise terms in faq, howto, and intro docs. 2024-06-09 14:40:18 -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 Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01: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 Added counterintuitive to the spelling wordlist to fix docs build error. 2024-07-08 22:36:33 -03: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/