1
0
mirror of https://github.com/django/django.git synced 2024-11-18 15:34:16 +00:00
django/docs
2011-02-09 12:59:05 +00:00
..
_ext
_theme/djangodocs
faq
howto
internals
intro Fixed #15153 - removed obsolete sentence in tutorial; thanks LeSphinx for the report. 2011-01-26 00:58:41 +00:00
man
misc
obsolete
ref
releases
topics Fixed #15241 -- Updated the upgrading notes for generic views to reflect recent changes in class-based views. Thanks to Jonney for the report and patch. 2011-02-09 12:59:05 +00:00
conf.py
contents.txt
glossary.txt
index.txt
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`` 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/