django/docs
Mariusz Felisiak 51a6edc4b0 [1.11.x] Fixed typo in docs/releases/1.11.29.txt.
Backport of 43f8ba1c7c from master
2020-03-04 10:49:40 +01:00
..
_ext [1.11.x] Replaced CVE/ticket roles with extlinks. 2019-02-01 15:55:49 -05:00
_theme [1.11.x] Clarified QuerySet.iterator()'s docs on server-side cursors. 2017-06-01 15:38:56 -04:00
faq [1.11.x] Refs #28814 -- Documented Python 3.7 compatibility. 2018-11-17 15:35:08 -05:00
howto [1.11.x] Removed extra characters in docs header underlines. 2019-02-08 21:44:04 +01:00
internals [1.11.x] Used extlinks for GitHub commits. 2019-02-01 15:55:56 -05:00
intro [1.11.x] Fixed #30277 -- Fixed broken links to packaging.python.org. 2019-03-21 10:08:38 -04:00
man [1.11.x] Updated man page for Django 1.11. 2017-04-04 11:53:56 -04:00
misc [1.11.x] Updated various links in docs to avoid redirects 2017-05-22 19:32:02 +02:00
ref [1.11.x] Fixed CVE-2019-12781 -- Made HttpRequest always trust SECURE_PROXY_SSL_HEADER if set. 2019-07-01 08:40:19 +02:00
releases [1.11.x] Fixed typo in docs/releases/1.11.29.txt. 2020-03-04 10:49:40 +01:00
topics [1.11.x] Removed extra characters in docs header underlines. 2019-02-08 21:44:04 +01:00
Makefile [1.11.x] Fixed docs build with Sphinx 1.6. 2017-05-24 09:47:24 -04:00
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
conf.py [1.11.x] Used extlinks for GitHub commits. 2019-02-01 15:55:56 -05: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 [1.11.x] Refs #17453 -- Fixed broken link to #django IRC logs. 2017-07-21 18:11:02 -04:00
make.bat
spelling_wordlist [1.11.x] Fixed #28548 -- Replaced 'middlewares' with 'middleware' in docs. 2017-08-30 06:26:04 -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/