django1

History

Claude Paroz 29d2f5a662 [2.2.x] Refs #26601 -- Used new-style middlewares in documentation. Backport of `d71497bb24` from master		2019-09-24 09:59:41 +02:00
..
_ext	Fixed crash building translated docs since Sphinx 1.8.	2018-10-01 20:44:02 -04:00
_theme	Refs #20910 -- Replaced snippet directive with code-block.	2018-09-10 13:00:34 -04:00
faq	[2.2.x] Used extlinks for Django's source code.	2019-03-28 20:39:38 -04:00
howto	[2.2.x] Fixed #30767 -- Improved references to deployment documentation.	2019-09-09 10:06:58 +02:00
internals	[2.2.x] Fixed typo in docs/internals/contributing/writing-documentation.txt.	2019-09-05 14:09:02 +02:00
intro	[2.2.x] Fixed #30775 -- Added admonition about missing imports to "Running tests" section in tutorial 5.	2019-09-16 10:05:02 +02:00
man	[2.2.x] Updated man page for Django 2.2.	2019-09-02 08:00:01 +02:00
misc	Updated various links in docs to avoid redirects	2017-05-22 19:28:44 +02:00
ref	[2.2.x] Refs #26601 -- Used new-style middlewares in documentation.	2019-09-24 09:59:41 +02:00
releases	[2.2.x] Fixed #30769 -- Fixed a crash when filtering against a subquery JSON/HStoreField annotation.	2019-09-16 08:53:31 +02:00
topics	[2.2.x] Refs #26601 -- Used new-style middlewares in documentation.	2019-09-24 09:59:41 +02:00
Makefile	Fixed docs build with Sphinx 1.6.	2017-05-24 09:13:26 -04:00
README	Removed sudo from pip commands in docs.	2014-09-22 15:49:48 -04:00
conf.py	[2.2.x] Used extlinks for Django's source code.	2019-03-28 20:39:38 -04: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/