1
0
mirror of https://github.com/django/django.git synced 2024-12-23 17:46:27 +00:00
django/docs
2012-10-05 11:32:28 -04:00
..
_ext Made more extensive usage of context managers with open. 2012-05-05 14:06:36 +02:00
_theme/djangodocs
faq Moved a note about django-admin.py errors from Tutorial Part 1 to a new FAQ Troubleshooting page. This is to avoid confusion for beginners. 2012-08-04 17:27:57 -07:00
howto [py3] Ported django.utils.encoding. 2012-08-07 12:00:22 +02:00
internals Put all the security-related notes in the same notice box. 2012-08-07 16:28:12 -04:00
intro Moved a note about django-admin.py errors from Tutorial Part 1 to a new FAQ Troubleshooting page. This is to avoid confusion for beginners. 2012-08-04 17:27:57 -07:00
man Fixed #18035 -- Removed deprecated AdminMediaHandler, as per official deprecation timeline. Thanks Jannis Leidel and Ramiro Morales for the review. 2012-04-08 21:13:32 +00:00
misc Fixed #18451 -- Vastly improved class based view documentation. 2012-06-11 10:40:23 +02:00
obsolete
ref Fixed typo in queryset docs under update method. 2012-10-05 11:32:28 -04:00
releases [py3] Ported django.utils.encoding. 2012-08-07 12:00:22 +02:00
topics [py3] Replaced __nonzero__ by __bool__ 2012-08-08 15:02:31 +02:00
conf.py [py3] Documented coding guidelines for Python 3. 2012-07-22 10:29:07 +02:00
contents.txt
glossary.txt Fixed #18451 -- Vastly improved class based view documentation. 2012-06-11 10:40:23 +02:00
index.txt And link security policies from documentation index. 2012-08-07 16:26:37 -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/