django1/docs
Carlton Gibson df59146825 [2.1.x] Removed issue reporter name from 2.1.15 release notes.
Backport of 368b8d20aa from master
2019-12-02 10:04:16 +01:00
..
_ext [2.1.x] Made versionadded/versionchanged annotations without a content end with ".". 2019-11-21 09:04:30 +01:00
_theme [2.1.x] Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 14:38:08 -04:00
faq [2.1.x] Refs #28814 -- Doc'd Python 3.7 compatibility in Django 1.11.x. 2018-11-17 16:04:33 -05:00
howto [2.1.x] Removed extra characters in docs header underlines. 2019-02-08 21:41:10 +01:00
internals [2.1.x] Used extlinks for GitHub commits. 2019-02-01 15:49:47 -05:00
intro [2.1.x] Fixed #30277 -- Fixed broken links to packaging.python.org. 2019-03-21 10:08:29 -04:00
man Updated man page for Django 2.1 alpha. 2018-05-17 09:30:20 -04:00
misc Updated various links in docs to avoid redirects 2017-05-22 19:28:44 +02:00
ref [2.1.x] Fixed #30953 -- Made select_for_update() lock queryset's model when using "self" with multi-table inheritance. 2019-12-02 08:13:13 +01:00
releases [2.1.x] Removed issue reporter name from 2.1.15 release notes. 2019-12-02 10:04:16 +01:00
topics [2.1.x] Clarified permission-related docs. 2019-02-28 15:29:32 +01: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.1.x] Used extlinks for GitHub commits. 2019-02-01 15:49:47 -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 [2.1.x] Removed dead links to botbot.me. 2018-11-10 17:25:47 -05:00
make.bat
spelling_wordlist [2.1.x] Fixed typos in comments and docs. 2018-08-01 16:13:18 -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/