1
0
mirror of https://github.com/django/django.git synced 2024-12-23 01:25:58 +00:00
django/docs
Jon Janzen f5c340684b Fixed #34901 -- Added async-compatible interface to session engines.
Thanks Andrew-Chen-Wang for the initial implementation which was posted
to the Django forum thread about asyncifying contrib modules.
2024-03-13 17:55:15 +01:00
..
_ext Applied Black's 2024 stable style. 2024-01-26 12:45:07 +01:00
_theme
faq Updated examples for 2.0+ release numbering in installation FAQ. 2023-12-15 06:16:02 +01:00
howto Fixed typos in docstrings and docs. 2024-03-07 06:01:01 +01:00
internals Fixed #14831 -- Extended template style guide in docs. 2024-03-11 11:05:54 +01:00
intro Removed distracting note from tutorial 4. 2024-02-21 06:21:20 +01:00
man Updated man page for Django 5.0 alpha. 2023-09-18 09:25:34 -03:00
misc Removed mention of designers in DTL design philosophy. 2024-02-01 09:20:11 +01:00
ref Fixed #25595 -- Doc'd that URLValidator rejects file:// URIs without a host. 2024-03-11 08:17:49 +01:00
releases Fixed #34901 -- Added async-compatible interface to session engines. 2024-03-13 17:55:15 +01:00
topics Fixed #34901 -- Added async-compatible interface to session engines. 2024-03-13 17:55:15 +01:00
conf.py Bumped version; main is now 5.1 pre-alpha. 2023-09-18 22:12:40 +02:00
contents.txt
glossary.txt
index.txt Reorganized the Contributing to Django docs. 2024-01-11 22:25:27 -03:00
make.bat Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
Makefile Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
README.rst
requirements.txt Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
spelling_wordlist Fixed #24018 -- Allowed setting pragma options on SQLite. 2024-02-16 12:59:19 +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/