django/docs
Sergey Fedoseev 86f0779d09 [2.1.x] Corrected output of Prefetch.to_attr example.
Backport of ba7a420012 from master.
2019-01-31 09:09:48 -05:00
..
_ext [2.1.x] Replaced CVE/ticket roles with extlinks. 2018-10-17 12:05:50 -04: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] Fixed broken links to PyYAML page. 2018-12-27 10:49:57 +01:00
internals [2.1.x] Updated some links to https and new locations. 2018-11-10 17:41:02 -05:00
intro [2.1.x] Fixed #29933 -- Fixed typo in docs/intro/contributing.txt. 2018-11-08 17:12:31 -05: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] Corrected output of Prefetch.to_attr example. 2019-01-31 09:09:48 -05:00
releases [2.1.x] Fixed #30097 -- Made 'obj' arg of InlineModelAdmin.has_add_permission() optional. 2019-01-11 18:03:23 -05:00
topics [2.1.x] Updated OWASP Top 10 link to the latest version. 2018-12-27 10:04:41 -05: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] Replaced CVE/ticket roles with extlinks. 2018-10-17 12:05:50 -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.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/