1
0
mirror of https://github.com/django/django.git synced 2024-12-25 10:35:48 +00:00
django/docs
2023-01-20 10:57:30 +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 Refs #26029 -- Deprecated DEFAULT_FILE_STORAGE and STATICFILES_STORAGE settings. 2023-01-12 09:58:36 +01:00
internals Refs #26029 -- Deprecated DEFAULT_FILE_STORAGE and STATICFILES_STORAGE settings. 2023-01-12 09:58:36 +01:00
intro Fixed #34232 -- Fixed typo in docs/intro/tutorial07.txt. 2023-01-04 13:26:34 +01:00
man Updated man page for Django 4.2 alpha. 2023-01-17 08:51:17 +01:00
misc
ref [4.2.x] Fixed #34242 -- Doc'd that primary key is set to None when deleting objects. 2023-01-20 10:57:30 +01:00
releases [4.2.x] Fixed typo in docs/releases/4.2.txt. 2023-01-17 19:28:19 +01:00
topics Fixed #23718 -- Doc'd that test mirrors require TransactionTestCase. 2023-01-16 09:31:34 +01:00
conf.py [4.2.x] Bumped django_next_version in docs config. 2023-01-17 08:54:30 +01:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README.rst
requirements.txt Bumped minimum Sphinx version to 4.5.0 in docs/requirements.txt. 2022-09-26 11:18:15 +02:00
spelling_wordlist Refs DEP 12 -- Renamed TB to Steering Council wherever mentioned. 2022-12-20 09:10:59 +01: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/