1
0
mirror of https://github.com/django/django.git synced 2024-12-23 17:46:27 +00:00
django/docs
2012-02-27 19:04:33 +00:00
..
_ext
_theme/djangodocs
faq
howto
internals
intro Fixed #17715 -- Updated the tutorial for time zone support, plus a few other improvements. 2012-02-26 21:17:58 +00:00
man
misc
obsolete
ref Added versionadded info for ensure_csrf_cookie decorator 2012-02-27 14:40:36 +00:00
releases Fixed #17772 -- typo in the release notes. 2012-02-26 20:48:48 +00:00
topics Added a diagram of the hierarchy of our TestCase subclasses to the testing docs. 2012-02-27 19:04:33 +00:00
conf.py
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README

The documentation in this tree is in plain text files and can be viewed using
any text file viewer.

Technically speaking, 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 on a Unix machine (Linux or Mac):

* Install Sphinx (using ``easy_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/