django1/docs
Tim Graham 5ac322dd1f [1.11.x] Fixed #28125 -- Clarified 1.11 release note about Template.render() prohibiting non-dict context.
Backport of bce5cc57e9 from master
2017-04-26 09:41:26 -04:00
..
_ext Fixed missing versionadded/changed annotations on docs.djangoproject.com. 2016-12-14 14:31:29 -05:00
_theme Fixed many spelling mistakes in code, comments, and docs. 2015-12-03 12:48:24 -05:00
faq [1.11.x] Renamed "Mac OS X" to "macOS" in docs. 2017-04-24 20:51:55 -04:00
howto [1.11.x] Fixed #28031 -- Removed notes about old uWSGI/sentry versions (refs #20537). 2017-04-06 09:34:11 -04:00
internals [1.11.x] Removed inappropriate highlighting in committing-code.txt. 2017-04-20 11:33:59 -04:00
intro [1.11.x] Renamed "Mac OS X" to "macOS" in docs. 2017-04-24 20:51:55 -04:00
man [1.11.x] Updated man page for Django 1.11. 2017-04-04 11:53:56 -04:00
misc Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
ref [1.11.x] Removed nonexistent methods from File's docs. 2017-04-25 20:17:31 -04:00
releases [1.11.x] Fixed #28125 -- Clarified 1.11 release note about Template.render() prohibiting non-dict context. 2017-04-26 09:41:26 -04:00
topics [1.11.x] Renamed "Mac OS X" to "macOS" in docs. 2017-04-24 20:51:55 -04:00
Makefile Added an "htmlview" target to open docs after building them. 2014-12-08 07:23:34 -05:00
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
conf.py [1.11.x] Bumped django_next_version in docs config. 2017-01-17 19:03:15 -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] Replaced docs/internals/team.txt with DSF teams page. 2017-03-14 16:37:04 -04:00
make.bat
spelling_wordlist [1.11.x] Refs #28091 -- Fixed typo and rephrased 1.11.1 release note. 2017-04-20 12:56:32 -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/