django/docs
Tim Graham f143e25883 [1.6.x] Added stub release notes for security releases. 2015-01-13 13:10:11 -05:00
..
_ext [1.6.x] Added sphinx extension to ease generation of ticket links. 2014-08-19 17:47:21 -04:00
_theme/djangodocs [1.6.x] Removed duplicate "Deprecated in Django A.B" text in docs. 2014-06-07 07:27:13 -04:00
faq [1.6.x] Removed need to update Python version support note on each new release. 2014-12-18 11:58:31 -05:00
howto [1.6.x] Fixed typo in docs/howto/deployment/wsgi/uwsgi.txt. 2014-12-07 12:26:26 -05:00
internals [1.6.x] Added sphinx extension to ease generation of ticket links. 2014-08-19 17:47:21 -04:00
intro [1.6.x] Replaced dead links to python-distribute.org. 2014-10-24 18:59:21 -04:00
man Revert "Patch by Claude for #16084." 2013-01-25 13:58:37 -03:00
misc [1.6.x] Fixed #21213 -- Added docs for Django's mailing lists. 2013-12-19 09:24:13 -05:00
ref [1.6.x] Fixed bad model example in admin docs. 2015-01-13 11:54:05 -05:00
releases [1.6.x] Added stub release notes for security releases. 2015-01-13 13:10:11 -05:00
topics [1.6.x] Updated six to 1.9.0. 2015-01-02 13:33:46 -05: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] Added sphinx extension to ease generation of ticket links. 2014-08-19 17:47:21 -04:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt [1.6.x] Fixed some intersphinx references. 2014-10-16 20:10:59 -04:00
index.txt [1.6.x] Fixed #24070 -- Added tutorial topics to doc index. 2015-01-03 08:49:17 -05: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/