1
0
mirror of https://github.com/django/django.git synced 2024-12-23 09:36:06 +00:00
django/docs
2024-12-04 17:03:55 +01:00
..
_ext [4.2.x] Fixed #34756 -- Fixed docs HTML build on Sphinx 7.1+. 2023-08-03 09:32:03 +02:00
_theme
faq [4.2.x] Refs #34118 -- Doc'd Python 3.12 compatibility in Django 4.2.x. 2023-11-19 16:38:33 +01:00
howto [4.2.x] Removed obsolete sentence in custom model field docs. 2023-11-15 13:53:03 +01:00
internals [4.2.x] Corrected note about using accents in writing documentation contributing guide. 2023-10-21 09:40:21 +02:00
intro [4.2.x] Refs #34118 -- Doc'd Python 3.12 compatibility in Django 4.2.x. 2023-11-19 16:38:33 +01:00
man [4.2.x] Updated man page for Django 4.2 final. 2023-04-03 08:56:48 +02:00
misc
ref [4.2.x] Fixed CVE-2024-45231 -- Avoided server error on password reset when email sending fails. 2024-09-03 09:42:25 -03:00
releases [4.2.x] Cleaned up CVE-2024-53907 and CVE-2024-53908 security archive descriptions. 2024-12-04 17:03:55 +01:00
topics [4.2.x] Fixed CVE-2024-45231 -- Avoided server error on password reset when email sending fails. 2024-09-03 09:42:25 -03:00
conf.py [4.2.x] Fixed docs build on Sphinx 8.1+. 2024-11-26 10:09:37 -03:00
contents.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
glossary.txt
index.txt [4.2.x] Added Django Forum to mailing lists page. 2023-03-24 08:58:45 +01:00
make.bat [4.2.x] Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:34:28 +01:00
Makefile [4.2.x] Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:34:28 +01:00
README.rst
requirements.txt [4.2.x] Pinned black == 23.12.1 for blacken-docs checks. 2024-01-30 05:47:27 +01:00
spelling_wordlist [4.2.x] Fixed #33405, Refs #7177 -- Clarified docs for filter escapejs regarding safe and unsafe usages. 2023-07-03 13:55:31 +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/