django1/docs
Carl Meyer 8a4f5de4b6 Fixed malformed directive in CBV date-based-mixins docs. 2013-09-27 11:58:41 -06:00
..
_ext Added a bugfix in docutils 0.11 -- docs will now build properly. 2013-07-31 09:24:29 -04:00
_theme/djangodocs Fixed #21702 -- Added different bullet styles for nested lists. 2013-09-23 07:37:09 -04:00
faq Fixed #19695 -- Retitle "Form Media" to "Form Assets". 2013-07-08 13:59:54 -04:00
howto Updated a code block to use the emphasize-lines Sphinx option 2013-09-25 11:39:38 -04:00
internals Added missing word in bio update. 2013-09-26 21:08:48 -07:00
intro Fixed #21141 -- Update Sphinx URL 2013-09-22 14:44:09 -03:00
man More migration docs, and conversion of all easy syncdb references 2013-07-25 16:19:36 +01:00
misc Fixed #19728 - Updated API stability doc to reflect current meaning of "stable". 2013-02-19 18:19:50 -05:00
ref Fixed malformed directive in CBV date-based-mixins docs. 2013-09-27 11:58:41 -06:00
releases Fixed #17671 - Cursors are now context managers. 2013-09-25 21:47:26 +03:00
topics Fixed #17671 - Cursors are now context managers. 2013-09-25 21:47:26 +03:00
Makefile Allowed overriding variables in docs/Makefile. 2013-07-29 06:51:54 -04:00
README Fixed #21141 -- Update Sphinx URL 2013-09-22 14:44:09 -03:00
conf.py Fixed #21141 -- Update Sphinx URL 2013-09-22 14:44:09 -03: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 Fixed #20877 -- added a performance optimization guide 2013-09-20 23:21:49 +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/