django

mirror of https://github.com/django/django.git synced 2024-12-26 19:16:11 +00:00

History

Yahya Ali e68da20596 [4.2.x] Fixed #34463 -- Corrected code-block directives in docs. Thanks ExTexan for the report. Backport of `263db8af46` from main		2023-04-06 13:08:44 +02:00
..
_ext
_theme
faq	[4.2.x] Fixed #34140 -- Reformatted code blocks in docs with blacken-docs.	2023-03-01 13:39:03 +01:00
howto	[4.2.x] Doc'd use of asgiref.sync adapters with sensitive variables.	2023-03-22 16:24:56 +01:00
internals	[4.2.x] Updated release process for 2.0+ release numbering and latest practices.	2023-04-04 07:28:42 +02:00
intro	[4.2.x] Fixed #34140 -- Reformatted code blocks in docs with blacken-docs.	2023-03-01 13:39:03 +01:00
man	[4.2.x] Updated man page for Django 4.2 final.	2023-04-03 08:56:48 +02:00
misc
ref	[4.2.x] Refs #34028 -- Doc'd that get_script_prefix() cannot be used outside of the request-response cycle.	2023-04-06 13:02:00 +02:00
releases	[4.2.x] Added release date for 4.1.8.	2023-04-05 06:19:12 +02:00
topics	[4.2.x] Fixed #34463 -- Corrected code-block directives in docs.	2023-04-06 13:08:44 +02: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	[4.2.x] Added Django Forum to mailing lists page.	2023-03-24 08:58:45 +01:00
make.bat	[4.2.x] Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs.	2023-03-01 13:34:28 +01:00
Makefile	[4.2.x] Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs.	2023-03-01 13:34:28 +01:00
README.rst
requirements.txt	[4.2.x] Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs.	2023-03-01 13:34:28 +01:00
spelling_wordlist	[4.2.x] Fixed #34146 -- Added 3rd-party lib tutorial step.	2023-02-07 20:22:11 +01: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/