1
0
mirror of https://github.com/django/django.git synced 2024-12-23 01:25:58 +00:00
django/docs
Nick Pope 9bd174b9a7 Updated documentation and comments for RFC updates.
- Updated references to RFC 1123 to RFC 5322
  - Only partial as RFC 5322 sort of sub-references RFC 1123.
- Updated references to RFC 2388 to RFC 7578
  - Except RFC 2388 Section 5.3 which has no equivalent.
- Updated references to RFC 2396 to RFC 3986
- Updated references to RFC 2616 to RFC 9110
- Updated references to RFC 3066 to RFC 5646
- Updated references to RFC 7230 to RFC 9112
- Updated references to RFC 7231 to RFC 9110
- Updated references to RFC 7232 to RFC 9110
- Updated references to RFC 7234 to RFC 9111
- Tidied up style of text when referring to RFC documents
2022-11-10 13:52:17 +01:00
..
_ext
_theme Fixed docs build with sphinxcontrib-spelling 7.5.0+. 2022-05-31 11:17:01 +02:00
faq Refs #33173 -- Doc'd Python 3.11 compatibility in Django 4.1.x. 2022-10-26 20:10:33 +02:00
howto Fixed #34054 -- Created a new fixtures topic. 2022-11-02 08:08:02 +01:00
internals Improved "rebase" example for upstream changes in working with Git docs. 2022-10-24 10:04:38 +02:00
intro Updated UTC uses to datetime.timezone.utc in docs. 2022-10-20 15:52:45 -07:00
man Updated man page for Django 4.1 alpha. 2022-05-17 11:21:08 +02:00
misc
ref Updated documentation and comments for RFC updates. 2022-11-10 13:52:17 +01:00
releases Fixed #34135 -- Added async-compatible interface to related managers. 2022-11-09 10:32:40 +01:00
topics Updated documentation and comments for RFC updates. 2022-11-10 13:52:17 +01:00
conf.py Bumped minimum Sphinx version to 4.5.0. 2022-05-31 15:21:17 +02:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile Fixed #33753 -- Fixed docs build on Sphinx 5+. 2022-06-01 12:13:15 +02:00
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 Removed obsolete references to pysqlite. 2022-11-04 08:03:06 +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/