django

mirror of https://github.com/django/django.git synced 2024-12-27 03:25:58 +00:00

History

Natalia e84d38ab36 [4.2.x] Added release date for 4.2.2. Backport of `0faad01938` from main		2023-06-05 08:26:28 -03:00
..
_ext
_theme
faq
howto	[4.2.x] Updated broken links in docs.	2023-05-17 12:13:40 +02:00
internals	[4.2.x] Fixed #34579 -- Added Django Forum to contributing guides.	2023-05-23 06:00:02 +02:00
intro	[4.2.x] Fixed #34579 -- Added Django Forum to contributing guides.	2023-05-23 06:00:02 +02:00
man
misc
ref	[4.2.x] Fixed #34595 -- Doc'd that format_string arg of format_html() is not escaped.	2023-06-01 13:10:45 +01:00
releases	[4.2.x] Added release date for 4.2.2.	2023-06-05 08:26:28 -03:00
topics	[4.2.x] Refs #23528 -- Made cosmetic edits to swappable_dependency() docs.	2023-06-03 12:02:08 +02:00
conf.py
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README.rst
requirements.txt
spelling_wordlist	[4.2.x] Fixed #34574 -- Noted unexpected outcomes in autoescape/escape docs.	2023-05-26 07:50:19 +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/