mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-06-18 18:09:13 +00:00
Code Issues 32 Releases Wiki Activity
django/docs
History
Mariusz Felisiak a7e89fe776 [3.2.x] Added stub release notes for 3.2.12 and 2.2.27. 
Backport of eeca9342381c8583be16f18942774e785ab7e527 from main.
2022-01-25 07:27:35 +01:00
..
_ext
[3.2.x] Fixed crash building HTML docs since Sphinx 4.3.
2021-11-18 11:23:02 +01:00
_theme
[3.2.x] Fixed #32860 -- Made docs permalinks focusable to improve accessibility.
2021-06-21 14:07:27 +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] Used backend vendors in custom model fields docs.
2021-08-24 16:17:13 +02:00
internals
[3.2.x] Corrected isort example in coding style docs.
2021-11-22 12:35:12 +01:00
intro
[3.2.x] Corrected module reference in contributing tutorial.
2021-11-03 07:48:14 +01: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 CVE-2021-45116 -- Fixed potential information disclosure in dictsort template filter.
2022-01-04 10:19:49 +01:00
releases
[3.2.x] Added stub release notes for 3.2.12 and 2.2.27.
2022-01-25 07:27:35 +01:00
topics
[3.2.x] Fixed CVE-2021-45115 -- Prevented DoS vector in UserAttributeSimilarityValidator.
2022-01-04 10:19:49 +01:00
conf.py
[3.2.x] Added requirements.txt to files ignored by Sphinx builds.
2021-11-30 11:58:43 +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
Makefile
Fixed docs build with Sphinx 1.6.
2017-05-24 09:13:26 -04:00
README.rst
Refs #25778 -- Updated sphinx-doc.org links to HTTPS.
2020-01-29 06:04:15 +01: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/