django

History

Adrian Holovaty 442ab475c8 Edited deployment doc changes from [17338] git-svn-id: http://code.djangoproject.com/svn/django/trunk@17421 bcc190cf-cafb-0310-a4f2-bffc1f526a37		2012-02-03 17:51:14 +00:00
..
_ext	…
_theme/djangodocs	…
faq	Fixed #17129 - Model FAQ: Link to south	2011-11-01 22:27:02 +00:00
howto	Edited deployment doc changes from [17338]	2012-02-03 17:51:14 +00:00
internals	…
intro	…
man	…
misc	…
obsolete	Fixed #14141 : docs now use the :doc: construct for links between documents.	2010-08-19 19:27:44 +00:00
ref	Edited models/options.txt changes from [17314]	2012-02-03 17:45:28 +00:00
releases	Fixed #16921 -- Added assertHTMLEqual and assertHTMLNotEqual assertions, and converted Django tests to use them where appropriate. Thanks Greg Müllegger.	2012-01-31 20:36:11 +00:00
topics	…
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/