django/docs
Tim Graham 082fad0b83 Cleaned up contrib.admin install instructions.
Thanks Cal Leeming for the patch.
2012-11-02 18:04:27 -04:00
..
_ext Made more extensive usage of context managers with open. 2012-05-05 14:06:36 +02:00
_theme/djangodocs Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0. 2010-07-24 10:21:21 +00:00
faq Documented minimal python 3.2 version. 2012-11-02 10:51:10 +01:00
howto Fixed #19208 -- Docs for mod_wsgi daemon mode 2012-10-29 21:39:12 +01:00
internals Fixed #18978 -- Moved cleanup command to sessions. 2012-10-27 18:31:00 +02:00
intro Fixed #19216 - Switched to user level installation in apps tutorial. 2012-10-31 19:56:53 -04:00
man Fixed #18035 -- Removed deprecated AdminMediaHandler, as per official deprecation timeline. Thanks Jannis Leidel and Ramiro Morales for the review. 2012-04-08 21:13:32 +00:00
misc Replaced mentions of Subversion by Git in docs 2012-10-14 23:03:01 +02:00
ref Cleaned up contrib.admin install instructions. 2012-11-02 18:04:27 -04:00
releases Fixed #17083 -- Allowed sessions to use non-default cache. 2012-10-31 09:46:16 +01:00
topics Fixed #15361 - Documented performance considerations for QuerySet.get() 2012-11-02 17:58:24 -04:00
Makefile Added gettext target to sphinx makefiles. 2012-04-07 22:35:57 +00:00
README Fixed #18928. Tightened language in docs/README. 2012-09-08 11:11:37 +05:30
conf.py Ensure that version detection in docs from 373df56d uses the right Django copy. 2012-10-28 18:18:09 -03:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt Fixed #18451 -- Vastly improved class based view documentation. 2012-06-11 10:40:23 +02:00
index.txt Fixed #16671 - Added a tutorial on reuseable apps 2012-10-30 18:40:21 -04:00
make.bat Added gettext target to sphinx makefiles. 2012-04-07 22:35:57 +00: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 ``sudo 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.pocoo.org/