django

mirror of https://github.com/django/django.git synced 2024-12-23 17:46:27 +00:00

History

Julien Phalip 79ef3901da Fixed the path to the admin's compress.py script in the doc.		2012-06-16 16:23:03 -07:00
..
_ext
_theme/djangodocs
faq
howto	Fixed #18451 -- Vastly improved class based view documentation.	2012-06-11 10:40:23 +02:00
internals	Fixed the path to the admin's compress.py script in the doc.	2012-06-16 16:23:03 -07:00
intro	Fixed #18451 -- Vastly improved class based view documentation.	2012-06-11 10:40:23 +02:00
man
misc	Fixed #18451 -- Vastly improved class based view documentation.	2012-06-11 10:40:23 +02:00
obsolete
ref	Fixed #18451 -- Vastly improved class based view documentation.	2012-06-11 10:40:23 +02:00
releases	Fixed #18451 -- Vastly improved class based view documentation.	2012-06-11 10:40:23 +02:00
topics	Fixed #18451 -- Vastly improved class based view documentation.	2012-06-11 10:40:23 +02:00
conf.py	Fixed #18269 -- Applied unicode_literals for Python 3 compatibility.	2012-06-07 18:08:47 +02:00
contents.txt
glossary.txt	Fixed #18451 -- Vastly improved class based view documentation.	2012-06-11 10:40:23 +02:00
index.txt	Fixed #18451 -- Vastly improved class based view documentation.	2012-06-11 10:40:23 +02:00
make.bat
Makefile
README

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/