django

mirror of https://github.com/django/django.git synced 2024-11-28 10:48:32 +01:00

History

Carlton Gibson 32d70b2f55 Refs #34118 -- Adopted asgiref coroutine detection shims. Thanks to Mariusz Felisiak for review.		2022-12-20 11:10:48 +01:00
..
_ext
_theme
faq	Refs #33173 -- Doc'd Python 3.11 compatibility in Django 4.1.x.	2022-10-26 20:10:33 +02:00
howto	Updated various links to HTTPS and new locations.	2022-12-06 05:59:43 +01:00
internals	Refs #34118 -- Adopted asgiref coroutine detection shims.	2022-12-20 11:10:48 +01:00
intro	Updated UTC uses to datetime.timezone.utc in docs.	2022-10-20 15:52:45 -07:00
man
misc
ref	Fixed #33662 -- Allowed Sitemap to customize languages for each item.	2022-12-19 12:51:52 +01:00
releases	Refs #34118 -- Adopted asgiref coroutine detection shims.	2022-12-20 11:10:48 +01:00
topics	Refs #34118 -- Adopted asgiref coroutine detection shims.	2022-12-20 11:10:48 +01:00
conf.py	Fixed #33308 -- Added support for psycopg version 3.	2022-12-15 06:17:57 +01:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README.rst
requirements.txt
spelling_wordlist	Refs DEP 12 -- Renamed TB to Steering Council wherever mentioned.	2022-12-20 09:10:59 +01: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/