django/docs
Tim Graham 541aa2434d Removed "how to release Django" steps for 1.4 (no longer supported). 2015-10-19 21:01:28 -04:00
..
_ext Removed obsolete literals_to_xrefs.py script. 2015-06-15 10:22:18 -04:00
_theme Added white-space: pre-wrap; to docs code blocks to match docs.dp.com. 2015-06-22 15:56:06 -04:00
faq Refs #14091 -- Fixed connection.queries on SQLite. 2015-09-17 23:01:33 +02:00
howto Fixed #25515 -- Documented the return value of BaseCommand.handle() 2015-10-06 15:08:15 -04:00
internals Removed "how to release Django" steps for 1.4 (no longer supported). 2015-10-19 21:01:28 -04:00
intro Fixed #25508 -- Modified QuerySet.__repr__() to disambiguate it from a list. 2015-10-06 12:38:34 -04:00
man Updated man page for Django 1.9 alpha. 2015-09-23 19:28:55 -04:00
misc Updated release process for new release schedule. 2015-06-25 11:36:17 -04:00
ref Refs #25535 -- Minor edits to ForeignObject check changes. 2015-10-14 05:21:08 -07:00
releases Fixed #25563 -- Cached deferred models in their proxied model's _meta.apps. 2015-10-19 20:11:32 -04:00
topics Refs #25527 -- Removed redundant doc heading link that leads to a warning when generating PDF. 2015-10-07 19:35:18 -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 Bumped version; master is now 1.10 pre-alpha. 2015-09-23 19:31:08 -04:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt Updated Wikipedia links to use https 2015-08-08 12:02:32 +02:00
index.txt Fixed #24961 -- Added links to all auth docs pages from index. 2015-06-09 12:41:39 -04:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
spelling_wordlist Refs #22789 -- Removed contrib.webdesign per deprecation timeline. 2015-09-23 19:31:09 -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/