django/docs
Gabriel Grant d69f1d71c4 Fixed typo in JSONResponseMixin example. 2012-06-25 08:48:32 +02:00
..
_ext Made more extensive usage of context managers with open. 2012-05-05 14:06:36 +02:00
_theme/djangodocs
faq Removed references to changes made in 1.2. 2012-06-07 15:02:35 +02:00
howto Fixed #18451 -- Vastly improved class based view documentation. 2012-06-11 10:40:23 +02:00
internals Fixed the path to the admin's compress.py script in the doc. 2012-06-16 16:23:03 -07:00
intro Fixed #18451 -- Vastly improved class based view documentation. 2012-06-11 10:40:23 +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 #18451 -- Vastly improved class based view documentation. 2012-06-11 10:40:23 +02:00
obsolete
ref Updated TEMPLATE_CONTEXT_PROCESSORS defaults in the docs. 2012-06-23 16:02:15 +02:00
releases Fixed #18454 -- Added ability to pass a list of signals to `receiver`. 2012-06-23 16:31:16 +02:00
topics Fixed typo in JSONResponseMixin example. 2012-06-25 08:48:32 +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 Fixed #18269 -- Applied unicode_literals for Python 3 compatibility. 2012-06-07 18:08:47 +02:00
contents.txt
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/