django1/docs
Tianyi Wang 60517c9c09 [1.6.x] Fixed #21625 -- incorrect documentation for DiscoverRunner.build_suite
Backport of b62031441b from master.
2013-12-18 14:30:20 +01:00
..
_ext [1.6.x] Added a bugfix in docutils 0.11 -- docs will now build properly. 2013-07-31 09:26:11 -04:00
_theme/djangodocs [1.6.x] Fixed #21558 -- Support building CHM files. 2013-12-04 16:51:37 +01:00
faq [1.6.x] Updated a bunch of hyperlinks in documentation 2013-12-08 18:48:30 +01:00
howto [1.6.x] Updated a bunch of hyperlinks in documentation 2013-12-08 18:48:30 +01:00
internals [1.6.x] Updated a bunch of hyperlinks in documentation 2013-12-08 18:48:30 +01:00
intro [1.6.x] Fixed link text for "Testing in Django" in tutorial 5. 2013-12-14 10:42:36 -05:00
man Revert "Patch by Claude for #16084." 2013-01-25 13:58:37 -03:00
misc Fixed #19728 - Updated API stability doc to reflect current meaning of "stable". 2013-02-19 18:19:50 -05:00
ref [1.6.x] Added some internal links to render_to_string documentation. 2013-12-15 23:03:26 +01:00
releases [1.6.x] Added 1.6.2 release notes stub. 2013-12-13 18:55:35 -05:00
topics [1.6.x] Fixed #21625 -- incorrect documentation for DiscoverRunner.build_suite 2013-12-18 14:30:20 +01:00
Makefile [1.6.x] Allowed overriding variables in docs/Makefile. 2013-07-29 06:52:42 -04:00
README Fixed #18928. Tightened language in docs/README. 2012-09-08 11:11:37 +05:30
conf.py [1.6.x] Bump version numbers for 1.6 release. 2013-11-06 07:54:49 -06: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 [1.6.x] Updated a bunch of hyperlinks in documentation 2013-12-08 18:48:30 +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/