django/docs
Tomer Chachamu 62917cee5a Doc'd the need to remove default ordering on Subquery aggregates. 2017-07-18 08:48:25 -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 Updated various links in docs to avoid redirects 2017-05-22 19:28:44 +02:00
howto Refs #23919 -- Stopped inheriting from object to define new style classes. 2017-06-26 10:30:31 -04:00
internals Refs #23919 -- Stopped inheriting from object to define new style classes. 2017-06-26 10:30:31 -04:00
intro Removed unneeded right quotes in docs to fix spelling errors. 2017-07-18 08:24:49 -04:00
man Discouraged use of /tmp with predictable names. 2015-12-24 09:54:33 -05:00
misc Updated various links in docs to avoid redirects 2017-05-22 19:28:44 +02:00
ref Doc'd the need to remove default ordering on Subquery aggregates. 2017-07-18 08:48:25 -04:00
releases Fixed #28399 -- Fixed QuerySet.count() for union(), difference(), and intersection() queries. 2017-07-15 08:20:12 -04:00
topics Removed unneeded right quotes in docs to fix spelling errors. 2017-07-18 08:24:49 -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 Fixed docs build with Sphinx 1.6. 2017-05-24 09:13:26 -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 Updated name of topics/db/queries link on index. 2017-07-11 08:15:13 -04:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
spelling_wordlist Fixed #28260 -- Allowed customizing the test tablespace initial and autoextend size on Oracle. 2017-06-02 18:35:56 +02: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/