django/docs
Tim Graham 07d70e9b26 Fixed #18656 -- Fixed LocaleMiddleware link; thanks mitar for the report. 2012-07-28 13:31:41 -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 #18601 -- Specified that Python minimum version is 2.6.5 2012-07-13 17:33:13 +02:00
howto Fixed #18626 -- rst syntax collision. 2012-07-15 11:25:13 +02:00
internals Update my bio. 2012-07-18 08:04:29 -07:00
intro Fixed #18630 -- Updated version in docs/intro/install.txt; thanks Kevin London. 2012-07-28 13:17:33 -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 Fixed #18451 -- Vastly improved class based view documentation. 2012-06-11 10:40:23 +02:00
obsolete Fixed #14141: docs now use the :doc: construct for links between documents. 2010-08-19 19:27:44 +00:00
ref Fixed #18656 -- Fixed LocaleMiddleware link; thanks mitar for the report. 2012-07-28 13:31:41 -04:00
releases Merge pull request #228 from nklas/master 2012-07-25 13:06:58 -07:00
topics [py3] Updated dict-like data structures for Python 3. 2012-07-25 22:58:48 +02:00
Makefile Added gettext target to sphinx makefiles. 2012-04-07 22:35:57 +00:00
README Fixed #9995 -- Updated the installation instructions to recommend pip. Also fixed ReST errors. Refs #9112. 2012-03-03 09:11:54 +00:00
conf.py [py3] Documented coding guidelines for Python 3. 2012-07-22 10:29:07 +02:00
contents.txt Fixed #13397 - Include third level headings in the TOC. thanks cyang for the suggestion, rleland for the patch. 2010-12-27 23:58:16 +00:00
glossary.txt Fixed #18451 -- Vastly improved class based view documentation. 2012-06-11 10:40:23 +02:00
index.txt Fixed #18451 -- Vastly improved class based view documentation. 2012-06-11 10:40:23 +02: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.

Technically speaking, 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/