django/docs
Tim Bell ee104251c4 Fixed #27403 -- Doc'd that QuerySet.prefetch_related() doesn't guarantee transactional consistency.
Added a note about the potential race condition in prefetch_related()
that could produce an inconsistent result, one that does not correspond
to any point in the database history.
2023-10-25 09:49:33 +02:00
..
_ext Fixed #34756 -- Fixed docs HTML build on Sphinx 7.1+. 2023-08-03 08:01:06 +02:00
_theme
faq Added stub release notes for 5.1. 2023-09-18 22:12:40 +02:00
howto Removed versionadded/changed annotations for 4.2. 2023-09-18 22:12:40 +02:00
internals Restructured writing documentation contributing guide. 2023-10-21 09:44:36 +02:00
intro Reorganized tutorial's part 4 to better understand changes needed in URLConf. 2023-10-10 10:49:27 -03:00
man Updated man page for Django 5.0 alpha. 2023-09-18 09:25:34 -03:00
misc
ref Fixed #27403 -- Doc'd that QuerySet.prefetch_related() doesn't guarantee transactional consistency. 2023-10-25 09:49:33 +02:00
releases Added stub release notes and release date for 4.2.7, 4.1.13, and 3.2.23. 2023-10-25 05:37:57 +02:00
topics Fixed #34808 -- Doc'd aggregate function's default argument. 2023-10-11 15:17:36 -03:00
conf.py Bumped version; main is now 5.1 pre-alpha. 2023-09-18 22:12:40 +02:00
contents.txt
glossary.txt
index.txt Added Django Forum to mailing lists page. 2023-03-24 08:32:17 +01:00
make.bat
Makefile
README.rst
requirements.txt
spelling_wordlist Added Uyghur language. 2023-08-12 20:37:15 +02: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/