1
0
mirror of https://github.com/django/django.git synced 2024-12-23 01:25:58 +00:00
django/docs
2022-10-13 19:49:57 +02:00
..
_ext
_theme Fixed docs build with sphinxcontrib-spelling 7.5.0+. 2022-05-31 11:17:01 +02:00
faq Added stub release notes for 4.2. 2022-05-17 14:22:06 +02:00
howto Fixed #26975 -- Clarified how Django looks for fixture files. 2022-09-25 21:37:21 +02:00
internals Refs #33990 -- Renamed TransactionTestCase.assertQuerysetEqual() to assertQuerySetEqual(). 2022-10-08 08:07:38 +02:00
intro Refs #33990 -- Renamed TransactionTestCase.assertQuerysetEqual() to assertQuerySetEqual(). 2022-10-08 08:07:38 +02:00
man Updated man page for Django 4.1 alpha. 2022-05-17 11:21:08 +02:00
misc
ref Refs #23919 -- Updated obsolete buffer() references to memoryview(). 2022-10-13 19:49:57 +02:00
releases Fixed #34069 -- Made LocaleMiddleware respect language from requests when i18n patterns are used. 2022-10-13 10:38:26 +02:00
topics Fixed #25996 -- Revised performance section in URLs topic docs. 2022-10-10 08:02:35 +02: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 Added Central Kurdish (Sorani) language. 2022-08-30 11:56:11 +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/