django/docs
Mariusz Felisiak 24f1a38b37 Added stub release notes and release date for 4.2.5, 4.1.11, and 3.2.21. 2023-08-28 06:10:20 +02:00
..
_ext Fixed #34756 -- Fixed docs HTML build on Sphinx 7.1+. 2023-08-03 08:01:06 +02:00
_theme Fixed docs build with sphinxcontrib-spelling 7.5.0+. 2022-05-31 11:17:01 +02:00
faq Fixed #34545 -- Corrected the number of months in installation FAQ. 2023-05-08 08:34:23 +02:00
howto Fixed #15799 -- Doc'd that Storage._open() should raise FileNotFoundError when file doesn't exist. 2023-08-04 17:39:05 +02:00
internals Fixed #33817 -- Added support for python-oracledb and deprecated cx_Oracle. 2023-08-10 10:11:53 +02:00
intro Fixed typo in docs/intro/tutorial08.txt. 2023-06-28 07:08:51 +02:00
man Updated man page for Django 4.2 alpha. 2023-01-17 08:51:17 +01:00
misc Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate. 2021-07-29 06:24:12 +02:00
ref Refs #33507 -- Doc'd using UUID data type on MariaDB 10.7+ in UUIDField docs. 2023-08-25 11:24:21 +02:00
releases Added stub release notes and release date for 4.2.5, 4.1.11, and 3.2.21. 2023-08-28 06:10:20 +02:00
topics Avoided counting exceptions in AsyncClient docs. 2023-08-24 05:19:52 +02:00
Makefile Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
README.rst
conf.py Removed unneeded escapes in regexes. 2023-08-02 19:53:16 +02:00
contents.txt
glossary.txt
index.txt Added Django Forum to mailing lists page. 2023-03-24 08:32:17 +01:00
make.bat Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
requirements.txt Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
spelling_wordlist Added Uyghur language. 2023-08-12 20:37:15 +02: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/