django1/docs
Tim Graham d156ae0612 [1.8.x] Fixed #25963 -- Clarified render_to_response() context_instance deprecation.
Backport of 36d0aa4303 from stable/1.9.x
2015-12-22 13:11:43 -05:00
..
_ext [1.8.x] Fixed #23751 -- Fixed code snippet formatting in docs PDF. 2015-11-16 20:32:51 -05:00
_theme [1.8.x] Made doc icon's edges smooth. 2015-11-14 08:12:26 -05:00
faq [1.8.x] Fixed #25881 -- Marked Python 3.2 in Django 1.8 as unsupported at the end of 2016. 2015-12-08 12:48:07 -05:00
howto [1.8.x] Fixed #25893 -- Corrected custom lookups example. 2015-12-11 08:45:14 -05:00
internals [1.8.x] Updated references to the TEST_* database settings. 2015-09-05 20:31:22 +02:00
intro [1.8.x] Clarified that the test client response content attribute is bytes. 2015-10-23 14:27:15 -04:00
man [1.8.x] Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:15:40 -04:00
misc Fixed #16785 -- Documented some of the design decisions of the cache framework. 2014-01-16 21:13:08 -05:00
ref [1.8.x] Fixed a typo in docs/ref/contrib/gis/geos.txt. 2015-12-18 07:09:31 -05:00
releases [1.8.x] Fixed #25963 -- Clarified render_to_response() context_instance deprecation. 2015-12-22 13:11:43 -05:00
topics [1.8.x] Fixed #25963 -- Clarified render_to_response() context_instance deprecation. 2015-12-22 13:11:43 -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 [1.8.x] Refs #23751 -- Added some unicode characters to the latex preamble. 2015-11-16 20:32:55 -05:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt [1.8.x] Updated Wikipedia links to use https 2015-08-08 12:09:53 +02:00
index.txt [1.8.x] Changed section title from "Model syntax" to "Introduction to models". 2015-11-16 09:54:30 -05:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
spelling_wordlist [1.8.x] Added "readded" to the docs wordlist. 2015-09-21 17:08:27 -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/