django/docs
Tim Graham 008e625c66 Fixed #19400 - Typo in docs/topics/auth.txt 2012-11-30 15:10:52 -05:00
..
_ext Made more extensive usage of context managers with open. 2012-05-05 14:06:36 +02:00
_theme/djangodocs Fixed #19317 - Added an image for warning blocks in the docs 2012-11-22 06:34:15 -05:00
faq Fixed #19315 -- Improved markup in admin FAQ. 2012-11-17 23:25:52 +01:00
howto Fix typo in file storage docs. 2012-11-17 23:25:37 +01:00
internals Fixed #19291 -- Completed deprecation of ADMIN_MEDIA_PREFIX. 2012-11-17 22:38:19 +01:00
intro Fixed #16779 - Added a contributing tutorial 2012-11-17 14:10:25 -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 Replaced mentions of Subversion by Git in docs 2012-10-14 23:03:01 +02:00
ref Fixed #19354 -- Do not assume usermodel.pk == usermodel.id 2012-11-29 21:45:43 +01:00
releases Typo in the 1.5 release notes 2012-11-28 14:19:05 +01:00
topics Fixed #19400 - Typo in docs/topics/auth.txt 2012-11-30 15:10:52 -05:00
Makefile Fixed #19266 -- Added Texinfo documentation target 2012-11-09 09:00:27 +01:00
README Fixed #18928. Tightened language in docs/README. 2012-09-08 11:11:37 +05:30
conf.py Fixed two docstring/comment typos. 2012-11-28 20:28:30 -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 #16779 - Added a contributing tutorial 2012-11-17 14:10:25 -05:00
make.bat Fixed #19266 -- Added Texinfo documentation target 2012-11-09 09:00:27 +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/