1
0
mirror of https://github.com/django/django.git synced 2024-12-25 02:26:12 +00:00
django/docs
2013-03-29 14:31:29 -04:00
..
_ext Fixed spelling errors 2013-03-28 11:16:53 -06:00
_theme/djangodocs
faq
howto
internals Minor updates to 'How is Django Formed.' 2013-03-28 15:31:05 -06:00
intro
man
misc
ref Fixed #20160 -- Erronous reference to module_name in admin doc. 2013-03-29 14:31:29 -04:00
releases Added 1.5.1 release notes. 2013-03-28 15:03:19 -05:00
topics Fixed #20159 -- Mispelled attribute in multi-db documentation example. 2013-03-29 14:16:30 -04: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.

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/