django/docs
Tim Graham 3df8ccf6fc [1.9.x] Fixed #28561 -- Removed inaccurate docs about QuerySet.order_by() and joins.
As of ccbba98131, both examples don't use
a join.

Backport of 44a6c27fd4 from master
2017-09-06 19:32:42 -04:00
..
_ext [1.9.x] Removed deprecated html_translator_class sphinx config option. 2017-01-23 10:21:36 -05:00
_theme [1.9.x] Fixed many spelling mistakes in code, comments, and docs. 2015-12-03 12:49:03 -05:00
faq [1.9.x] Fixed #26894 -- Fixed a typo in docs/faq/admin.txt 2016-07-14 08:04:57 -04:00
howto [1.9.x] Fixed typo in docs/howto/custom-template-tags.txt. 2017-03-01 15:43:33 -05:00
internals [1.9.x] Refs #24154 -- Added check_aggregate_support() to deprecation timeline. 2016-12-31 14:06:23 -05:00
intro [1.9.x] Fixed #27115 -- Corrected a screenshot in the tutorial. 2016-08-24 09:00:12 -04:00
man [1.9.x] Discouraged use of /tmp with predictable names. 2015-12-24 09:56:54 -05:00
misc [1.9.x] Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:18:24 -05:00
ref [1.9.x] Fixed #28561 -- Removed inaccurate docs about QuerySet.order_by() and joins. 2017-09-06 19:32:42 -04:00
releases [1.9.x] Removed redundant backticks in docs/releases/1.8.txt 2017-08-21 12:14:37 +02:00
topics [1.9.x] Removed unexpected initial attribute in data migration examples. 2017-03-25 16:00:31 -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.9.x] Removed deprecated html_translator_class sphinx config option. 2017-01-23 10:21:36 -05:00
contents.txt [1.9.x] Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:18:24 -05:00
glossary.txt [1.9.x] Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:18:24 -05:00
index.txt [1.9.x] Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:18:24 -05:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
spelling_wordlist [1.9.x] Fixed #26267 -- Fixed BoundField to reallow slices of subwidgets. 2016-02-24 07:03:24 -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/