1
0
mirror of https://github.com/django/django.git synced 2025-01-11 10:56:28 +00:00
django/docs
2011-09-13 08:22:53 +00:00
..
_ext
_theme/djangodocs
faq Fixed typo in PEP number introduced in last commit. Thanks Jannis for the eagle eyes. 2011-09-04 22:42:11 +00:00
howto Fixed #16276 -- Noted in the deployment documentation index that the Django Book 2nd ed. was written against Django 1.1. Thanks to bshaurette and bluejeansummer for the patch. 2011-09-11 01:12:11 +00:00
internals Fixed #14675 -- Completed removal of from django.conf.urls.default import * usage. 2011-09-11 22:36:16 +00:00
intro Fixed #14675 -- Completed removal of from django.conf.urls.default import * usage. 2011-09-11 22:36:16 +00:00
man
misc Converted links to external topics so they use intersphinx extension markup. 2011-09-04 21:17:30 +00:00
obsolete
ref Fixed some improper quotes in the form fields reference doc. 2011-09-12 07:15:47 +00:00
releases Fixed #14675 -- Completed removal of from django.conf.urls.default import * usage. 2011-09-11 22:36:16 +00:00
topics Fixed #16815 -- Rectified the code example for hidden_fields and visible_fields in the forms documentation. Thanks, joonas. 2011-09-13 08:22:53 +00:00
conf.py Converted links to external topics so they use intersphinx extension markup. 2011-09-04 21:17:30 +00:00
contents.txt
glossary.txt Converted links to external topics so they use intersphinx extension markup. 2011-09-04 21:17:30 +00:00
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.

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 on a Unix machine (Linux or Mac):

* Install Sphinx (using ``easy_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/