1
0
mirror of https://github.com/django/django.git synced 2024-12-29 04:26:28 +00:00
django/docs
2013-06-28 16:38:55 +02:00
..
_ext
_theme/djangodocs
faq Updated FAQ to reflect official Python 3 support 2013-06-28 16:38:55 +02:00
howto Add missing preposition in documentation 2013-06-26 10:25:34 -07:00
internals Fixed #14881 -- Modified password reset to work with a non-integer UserModel.pk. 2013-06-26 13:11:47 -04:00
intro Fixed missing slash in reusable apps tutorial. 2013-06-28 09:43:14 +02:00
man
misc
ref Support 'pyformat' style parameters in raw queries, Refs #10070 2013-06-28 06:59:10 +03:00
releases Support 'pyformat' style parameters in raw queries, Refs #10070 2013-06-28 06:59:10 +03:00
topics Support 'pyformat' style parameters in raw queries, Refs #10070 2013-06-28 06:59:10 +03:00
conf.py Master is now pre-1.7. 2013-06-28 08:56:45 -05:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile Allow build of translated documentation 2013-06-08 16:13:51 +02:00
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/