django1/docs
Tianyi Wang b62031441b Fixed #21625 -- incorrect documentation for DiscoverRunner.build_suite 2013-12-18 14:12:04 +01:00
..
_ext Fixed E127 pep8 warnings. 2013-12-14 11:59:15 -05:00
_theme/djangodocs Fixed #21558 -- Support building CHM files. 2013-12-04 16:46:56 +01:00
faq Updated a bunch of hyperlinks in documentation 2013-12-08 18:40:09 +01:00
howto Updated a bunch of hyperlinks in documentation 2013-12-08 18:40:09 +01:00
internals Deprecated get_app_package, get_app_path and get_app_paths. 2013-12-17 10:17:45 +01:00
intro Fixed link text for "Testing in Django" in tutorial 5. 2013-12-14 10:41:26 -05:00
man Enabled makemessages to support several translation directories 2013-11-30 11:00:23 +01:00
misc Whitespace cleanup. 2013-10-10 16:49:20 -04:00
ref Fixed #17413 -- Serialization of form errors along with all metadata. 2013-12-16 16:33:28 -05:00
releases Fixed #17413 -- Serialization of form errors along with all metadata. 2013-12-16 16:33:28 -05:00
topics Fixed #21625 -- incorrect documentation for DiscoverRunner.build_suite 2013-12-18 14:12:04 +01:00
Makefile Allowed overriding variables in docs/Makefile. 2013-07-29 06:51:54 -04:00
README Whitespace cleanup. 2013-10-10 16:49:20 -04:00
conf.py Fixed all E261 warnings 2013-11-02 18:20:39 -04: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 Updated a bunch of hyperlinks in documentation 2013-12-08 18:40:09 +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-doc.org/