django/docs
Tim Graham 06f5da3d78 Fixed #16817 - Added a guide of code coverage to contributing docs.
Thanks Pedro Lima for the draft patch.
2012-10-11 06:11:52 -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 Fixed #11460 - Added a FAQ regarding missing rows in the admin. 2012-09-27 17:36:02 -04:00
howto Fixed #19006 - Quoted filenames in Content-Disposition header. 2012-10-03 17:44:56 -04:00
internals Fixed #16817 - Added a guide of code coverage to contributing docs. 2012-10-11 06:11:52 -04:00
intro Fixed #18807 -- Made 404.html and 500.html optional 2012-09-30 23:16:19 +02: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 Fixed #18934 - Removed versionadded/changed annotations for Django 1.3 2012-09-20 19:06:55 -04:00
ref Fixed #19097 -- documented module of origin for HttpRes/req objects 2012-10-09 20:30:28 -07:00
releases Moved F() '&' and '|' to .bitand() and .bitor() 2012-10-10 01:15:29 +03:00
topics Fixed #16817 - Added a guide of code coverage to contributing docs. 2012-10-11 06:11:52 -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 Added latex preamble for ≤. 2012-08-28 22:45:51 +02: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 two broken links introduced in recent commits. 2012-09-27 17:33:52 -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/