django/docs
Tim Graham e8e28e747f [2.2.x] Updated CVE URL.
Backport of 656b331b13 from master
2021-01-02 12:51:06 +01:00
..
_ext [2.2.x] Fixed CodeBlock deprecation warning on Sphinx 2.1+. 2020-06-02 10:56:22 +02:00
_theme Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 13:00:34 -04:00
faq [2.2.x] Refs #31040 -- Doc'd Python 3.9 compatibility. 2020-10-13 08:45:37 +02:00
howto [2.2.x] Fixed #30999 -- Fixed typo in docs/howto/custom-template-tags.txt. 2019-11-19 10:09:55 +01:00
internals [2.2.x] Skipped GetImageDimensionsTests.test_webp when WEBP is not installed. 2020-10-06 11:32:34 +02:00
intro [2.2.x] Fixed term warning on Sphinx 3.0.1+. 2020-06-02 10:57:46 +02:00
man [2.2.x] Updated man page for Django 2.2. 2019-11-04 08:44:55 +01:00
misc [2.2.x] Expanded API stability docs to include our policy of continual improvement. 2019-11-18 21:40:22 +01:00
ref [2.2.x] Fixed #31790 -- Fixed setting SameSite cookies flag in HttpResponse.delete_cookie(). 2020-07-16 09:35:35 +02:00
releases [2.2.x] Set release date for 2.2.17. 2020-11-02 08:39:12 +01:00
topics [2.2.x] Fixed highlightlang deprecation warning on Sphinx 1.8+. 2020-06-02 10:57:25 +02:00
Makefile Fixed docs build with Sphinx 1.6. 2017-05-24 09:13:26 -04:00
README
conf.py [2.2.x] Updated CVE URL. 2021-01-02 12:51:06 +01:00
contents.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
glossary.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
index.txt [2.2.x] Fixed #30767 -- Improved references to deployment documentation. 2019-09-09 10:06:58 +02:00
make.bat
spelling_wordlist Fixed #28990 -- Added autosummarize parameter to BrinIndex. 2018-08-02 11:26:58 -04:00

README

The documentation in this tree is in plain text files and can be viewed using
any text file viewer.

It uses ReST (reStructuredText) [1], and the Sphinx documentation system [2].
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 ``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.

[1] http://docutils.sourceforge.net/rst.html
[2] http://sphinx-doc.org/