0
0
mirror of https://github.com/django/django.git synced 2024-11-29 22:56:46 +01:00
django/docs
2012-09-07 17:12:11 -04:00
..
_ext
_theme/djangodocs
faq Updated install docs to reflect Python 3 status. 2012-09-07 17:12:11 -04:00
howto [py3] Ported django.utils.safestring. 2012-08-18 16:04:06 +02:00
internals Fixed #18647 - Removed link to Malcolm's blog which is gone. 2012-08-30 07:44:41 -04:00
intro Updated install docs to reflect Python 3 status. 2012-09-07 17:12:11 -04:00
man
misc Fixed #18451 -- Vastly improved class based view documentation. 2012-06-11 10:40:23 +02:00
obsolete
ref Merge pull request #333 from brad/ticket_18917 2012-09-07 12:00:01 -07:00
releases Fixed minor typo in 1.3 release notes. 2012-09-06 21:00:16 +10:00
topics Updated install docs to reflect Python 3 status. 2012-09-07 17:12:11 -04:00
conf.py Added latex preamble for ≤. 2012-08-28 22:45:51 +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 #17378 - Added a flattened index for class-based views. 2012-09-01 09:20:38 -04:00
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/