django/docs
Tim Graham 2545dc59bf [1.5.x] Fixed #17312 - Warned about database side effects in tests.
Thanks jcspray for the suggestion.

Backport of 7df03268a4 from master.
2012-12-18 08:05:12 -05:00
..
_ext Made more extensive usage of context managers with open. 2012-05-05 14:06:36 +02:00
_theme/djangodocs [1.5.X] Fixed #19317 - Added an image for warning blocks in the docs 2012-11-22 08:47:52 -05:00
faq [1.5.X] Fixed #19344 - Documented how to run django-admin in a virtualenv on Windows. 2012-12-15 09:30:46 -05:00
howto [1.5.x] Fix typo in file storage docs. 2012-11-17 23:27:05 +01:00
internals [1.5.x] Fixed #19389 -- Docs on the location of contrib apps tests. 2012-12-08 19:48:41 +01:00
intro [1.5.X] Fixed #19344 - Documented how to run django-admin in a virtualenv on Windows. 2012-12-15 09:30:46 -05: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 [1.5.X] Removed PHP references 2012-12-14 19:33:48 -05:00
ref [1.5.X] Fixed #18718 - Documented django.utils.encoding.filepath_to_uri 2012-12-16 14:40:10 -05:00
releases [1.5.X] Fixed #19384 -- Documented the behavior of custom managers on abstract models. 2012-12-15 22:46:55 +08:00
topics [1.5.x] Fixed #17312 - Warned about database side effects in tests. 2012-12-18 08:05:12 -05:00
Makefile [1.5.x] Fixed #19266 -- Added Texinfo documentation target 2012-11-09 09:03:52 +01:00
README Fixed #18928. Tightened language in docs/README. 2012-09-08 11:11:37 +05:30
conf.py [1.5.x] Bump version numbers for security release. 2012-12-10 15:49:48 -06: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 [1.5.X] Fixed #9962 - Added a testing tutorial. 2012-12-15 08:12:25 -05:00
make.bat [1.5.x] Fixed #19266 -- Added Texinfo documentation target 2012-11-09 09:03:52 +01: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/