django/docs
Ramon Moraes 2c6906a0c4 [1.5.x] Updated xhtml2pdf URL in docs. 2016-02-16 07:05:32 -05:00
..
_ext [1.5.x] Fixed #21869 -- Fixed docs building with Sphinx 1.2.1. 2014-01-24 09:05:55 -05:00
_theme/djangodocs [1.5.x] Fixed #21558 -- Support building CHM files. 2013-12-04 16:52:04 +01:00
faq [1.5.x] Fixed #15379 - Added "how to cite Django" to FAQ. 2013-03-29 16:50:33 -04:00
howto [1.5.x] Updated xhtml2pdf URL in docs. 2016-02-16 07:05:32 -05:00
internals [1.5.x] Fixed #22457 -- Fixed contributing guide w/o github set-up 2014-04-16 09:40:32 -04:00
intro [1.5.x] Fixed #22842 2014-06-15 21:13:05 +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 [1.5.X] Fixed #19728 - Updated API stability doc to reflect current meaning of "stable". 2013-02-19 18:20:46 -05:00
ref [1.5.x] Direct readers to format_html() in mark_safe() docs. 2015-01-15 08:32:32 +00:00
releases [1.5.x] Added dates to release notes. 2015-01-02 19:22:03 -05:00
topics [1.5.x] Fixed #23267 -- Fixed typo in Translation documentation 2014-08-11 12:10:52 +02:00
Makefile [1.5.x] Allowed overriding variables in docs/Makefile. 2013-07-29 06:52:50 -04:00
README Fixed #18928. Tightened language in docs/README. 2012-09-08 11:11:37 +05:30
conf.py [1.5.x] Bumped version for 1.5.12 release. 2015-01-02 20:54:56 -05: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.5.x] Fixed #21180 -- Additional deprecation notes for databrowse. 2013-10-01 10:21:04 -04:00
make.bat [1.5.x] Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:50:00 -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/