django/docs
Tim Graham 7468c948b6 Clarified deprecation of test.utils.TestTemplateLoader. 2015-01-18 14:18:53 -05:00
..
_ext Fixed #23968 -- Replaced list comprehension with generators and dict comprehension 2014-12-08 07:58:23 -05:00
_theme Added newlines to the ends of CSS, HTML, and JavaScript files missing them. 2014-08-12 19:22:09 -04:00
faq Removed compatibility with Python 3.2. 2015-01-17 09:00:17 -05:00
howto Standardized indentation in docs/howto/custom-management-commands.txt. 2015-01-17 13:38:01 -05:00
internals Clarified deprecation of test.utils.TestTemplateLoader. 2015-01-18 14:18:53 -05:00
intro Removed support for custom SQL per deprecation timeline. 2015-01-17 10:16:06 -05:00
man Removed the validate management command per deprecation timeline. 2015-01-17 19:12:03 -05:00
misc Fixed #16785 -- Documented some of the design decisions of the cache framework. 2014-01-16 21:13:08 -05:00
ref Removed contrib.sites.models.RequestSite/get_current_site() aliases. 2015-01-18 13:36:32 -05:00
releases Clarified deprecation of test.utils.TestTemplateLoader. 2015-01-18 14:18:53 -05:00
topics Removed dumpdata --natural option and serializers use_natural_keys parameter. 2015-01-17 20:18:34 -05: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 to 1.9 in docs config. 2015-01-16 18:30:28 -05:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt Fixed some intersphinx references. 2014-10-16 20:00:17 -04:00
index.txt Removed FastCGI support per deprecation timeline; refs #20766. 2015-01-17 08:32:31 -05:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
spelling_wordlist Removed support for custom SQL per deprecation timeline. 2015-01-17 10:16:06 -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/