1
0
mirror of https://github.com/django/django.git synced 2025-01-11 10:56:28 +00:00
django/docs
2011-09-22 22:44:00 +00:00
..
_ext
_theme/djangodocs
faq
howto
internals Fixed #16907 (again) -- Added deprecation of databrowse to the deprecation docs. 2011-09-22 22:44:00 +00:00
intro
man
misc
obsolete
ref Fixed ReST errors that stopped some staticfiles docs being rendered 2011-09-22 21:52:00 +00:00
releases Fixed #16907 -- Deprecate databrowse. 2011-09-22 04:10:02 +00:00
topics Fixed 11674 -- Clarified docs on excluded fields of ModelForms. 2011-09-22 04:52:43 +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/