django/docs
Mariusz Felisiak 3591e1c1ac [3.2.x] Added CVE-2024-27351 to security archive.
Backport of da39ae4b5f from main
2024-03-04 10:13:19 +01:00
..
_ext [3.2.x] Fixed #34756 -- Fixed docs HTML build on Sphinx 7.1+. 2023-08-03 09:38:10 +02:00
_theme [3.2.x] Fixed docs build with sphinxcontrib-spelling 7.5.0+. 2022-06-27 08:10:48 +02:00
faq [3.2.x] Refs #32074 -- Doc'd Python 3.10 compatibility in Django 3.2.x. 2021-10-05 13:33:15 +02:00
howto [3.2.x] Fixed docs build with sphinxcontrib-spelling 7.5.0+. 2022-06-27 08:10:48 +02:00
internals [3.2.x] Fixed docs build with sphinxcontrib-spelling 7.5.0+. 2022-06-27 08:10:48 +02:00
intro [3.2.x] Fixed docs build with sphinxcontrib-spelling 7.5.0+. 2022-06-27 08:10:48 +02:00
man [3.2.x] Updated manpage for Django 3.2 final. 2021-04-06 11:02:06 +02:00
misc Expanded API stability docs to include our policy of continual improvement. 2019-11-18 20:37:46 +01:00
ref [3.2.x] Fixed documented alias of smart_text(). 2024-01-11 20:16:20 +01:00
releases [3.2.x] Added CVE-2024-27351 to security archive. 2024-03-04 10:13:19 +01:00
topics [3.2.x] Fixed CVE-2023-31047, Fixed #31710 -- Prevented potential bypass of validation when uploading multiple files using one form field. 2023-05-03 13:58:52 +02:00
Makefile [3.2.x] Fixed #33753 -- Fixed docs build on Sphinx 5+. 2022-06-01 12:15:27 +02:00
README.rst Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 2020-01-29 06:04:15 +01:00
conf.py [3.2.x] Disabled auto-created table of contents entries on Sphinx 5.2+. 2022-12-29 06:15:37 +01:00
contents.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
glossary.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
index.txt Fixed #25712 -- Reorganized templates docs. 2020-04-30 08:12:09 +02:00
make.bat [3.2.x] Added spelling option to make.bat. 2021-04-30 14:09:59 +02:00
requirements.txt [3.2.x] Refs #33247 -- Corrected configuration for Read The Docs. 2021-11-03 18:55:32 +01:00
spelling_wordlist [3.2.x] Added 'formatter' to spelling wordlist. 2021-10-12 15:17:11 +02:00

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/