django/docs
Adrian Holovaty 00227b6529 Edited serialization.txt changes from [17355]
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17427 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2012-02-03 20:16:06 +00:00
..
_ext
_theme/djangodocs
faq
howto
internals Updated my bio. 2012-01-25 16:43:52 +00:00
intro
man
misc
obsolete
ref Edited django-admin.txt changes from [17340] 2012-02-03 17:52:39 +00:00
releases
topics Edited serialization.txt changes from [17355] 2012-02-03 20:16:06 +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/