django

History

…
..
_ext	…
_theme/djangodocs	…
faq	…
howto	Fixed #17309 -- Typo in the IGNORABLE_404_URLS example.	2011-11-28 19:41:58 +00:00
internals	Edited release-process.txt changes from [17300]	2011-12-30 20:39:08 +00:00
intro	…
man	…
misc	Fixed many more ReST indentation errors, somehow accidentally missed from [16955]	2011-10-14 00:12:01 +00:00
obsolete	Fixed #14141 : docs now use the :doc: construct for links between documents.	2010-08-19 19:27:44 +00:00
ref	Fixed #640 - Documented that changing order_with_respect_to requires a schema change; thanks fcurella and poirier for the draft patches.	2011-12-31 15:30:22 +00:00
releases	Added a bit to the 1.4 release notes about the new SECURE_PROXY_SSL_HEADER setting	2011-12-30 21:13:53 +00:00
topics	Edited testing.txt changes from [17289]	2011-12-30 20:34:07 +00:00
Makefile	…
README	…
conf.py	…
contents.txt	…
glossary.txt	…
index.txt	…
make.bat	…

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/