1
0
mirror of https://github.com/django/django.git synced 2024-12-25 18:46:22 +00:00
django/docs
2011-12-07 22:31:39 +00:00
..
_ext Removed use of non-standard indentation rules in docs, and the custom transform that supported them. 2011-10-10 17:32:33 +00:00
_theme/djangodocs
faq Fixed #17129 - Model FAQ: Link to south 2011-11-01 22:27:02 +00:00
howto Fixed #17309 -- Typo in the IGNORABLE_404_URLS example. 2011-11-28 19:41:58 +00:00
internals Clarified release note about the removal of 'mixin' parameter to Storage.open, and added a note in the deprecation timeline. 2011-11-29 12:01:38 +00:00
intro Fixed #17028 - Changed diveintopython.org -> diveintopython.net 2011-11-19 22:57:20 +00:00
man
misc Fixed many more ReST indentation errors, somehow accidentally missed from [16955] 2011-10-14 00:12:01 +00:00
obsolete
ref Made BoundFields iterable, so that you can iterate over individual radio buttons of a RadioSelect in a template 2011-12-07 22:31:39 +00:00
releases Punctuation fix in the 1.4 release notes 2011-11-29 14:20:23 +00:00
topics Fixed #17220 - Documented git clone command for git < 1.6.6; thanks krzysiumed for the patch. 2011-11-21 23:40:11 +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 Fixed #16277 -- Changed the link to the IRC logs. 2011-11-25 19:40:46 +00:00
make.bat Fixed #16414 -- Added standard Windows make batch file for Sphinx. Thanks, Aymeric Augustin. 2011-07-19 09:00:24 +00:00
Makefile
README Fixed #16414 -- Added standard Windows make batch file for Sphinx. Thanks, Aymeric Augustin. 2011-07-19 09:00:24 +00:00

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/