django/docs
Tim Graham 36b399d6b3 [2.0.x] Added stub release notes for 2.0.5.
Backport of 87639adcd1 from master
2018-04-02 23:05:58 -04:00
..
_ext Refs #23968 -- Removed unnecessary lists, generators, and tuple calls. 2017-06-01 19:08:59 -04:00
_theme Clarified QuerySet.iterator()'s docs on server-side cursors. 2017-06-01 15:38:30 -04:00
faq Fixed #27855 -- Updated docs for Python 3.4 support in Django 2.0. 2017-08-11 11:17:08 -04:00
howto [2.0.x] Fixed #29265 -- Removed the suggestion to hardcode static URLs. 2018-03-28 12:35:21 -04:00
internals [2.0.x] Fixed links to Sphinx docs. 2018-03-30 14:59:57 -04:00
intro [2.0.x] isorted import statements in tutorial example. 2018-03-22 14:03:59 +01:00
man [2.0.x] Updated man page for Django 2.0 alpha. 2017-09-22 12:26:46 -04:00
misc Updated various links in docs to avoid redirects 2017-05-22 19:28:44 +02:00
ref [2.0.x] Added a pagination example to ListView docs. 2018-03-26 12:41:30 -04:00
releases [2.0.x] Added stub release notes for 2.0.5. 2018-04-02 23:05:58 -04:00
topics [2.0.x] Clarified a sentence in docs/topics/i18n/translation.txt. 2018-03-31 19:34:07 -04: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.0.x] Bumped django_next_version in docs config. 2017-09-22 12:21:21 -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.0.x] Fixed #28594 -- Removed Jython docs and specific code 2017-12-23 10:28:29 +01:00
make.bat
spelling_wordlist [2.0.x] Fixed "template tag" spelling in docs. 2018-01-23 09:48:31 -05: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/