django/docs
Claude Paroz 4e2e8f39d1 Fixed #4833 -- Validate email addresses with localhost as domain 2013-01-11 20:45:46 +01:00
..
_ext Made more extensive usage of context managers with open. 2012-05-05 14:06:36 +02:00
_theme/djangodocs Addeded CSS to bold deprecation notices. 2013-01-09 19:03:34 -05:00
faq Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
howto Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
internals Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
intro Fixed #19437 - Clarified pip install instructions in contributing tutorial. 2013-01-11 07:01:56 -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 Removed django.contrib.localflavor. 2012-12-29 21:59:06 +01:00
ref Fixed #4833 -- Validate email addresses with localhost as domain 2013-01-11 20:45:46 +01:00
releases Fixed typo in 1.5 release notes; thanks Jonas Obrist. 2013-01-07 20:16:46 -07:00
topics Fixed code examples in which render() calls were missing `request` parameter. 2013-01-11 15:52:47 -03:00
Makefile Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
README Fixed #18928. Tightened language in docs/README. 2012-09-08 11:11:37 +05:30
conf.py Fixed broken links, round 3. refs #19516 2012-12-26 19:07:22 -05: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 Removed django.contrib.localflavor. 2012-12-29 21:59:06 +01:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05: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/