1
0
mirror of https://github.com/django/django.git synced 2025-01-11 19:06:26 +00:00
django/docs
2012-05-03 08:57:22 +02:00
..
_ext Replaced print statement by print function (forward compatibility syntax). 2012-04-30 20:45:03 +02:00
_theme/djangodocs
faq
howto Replaced print statement by print function (forward compatibility syntax). 2012-04-30 20:45:03 +02:00
internals
intro Replaced print statement by print function (forward compatibility syntax). 2012-04-30 20:45:03 +02:00
man
misc
obsolete
ref Fixed #18246 -- Replaced bash-specific syntax in geodjango postgis helper script. 2012-05-01 20:33:50 +02:00
releases
topics Fixed #18214 -- Clarified the docs about serializable objects. 2012-05-03 08:57:22 +02: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:

* Install Sphinx (using ``sudo pip 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/