django

History

Julien Phalip 406f9d1fa0 Fixed #7609 -- Noted in the model fields reference documentation that `PositiveIntegerField` accepts the value 0 for backwards-compatibility reasons. Thanks to everyone involved in the resolution of this issue, including Paul Collins for the patch. git-svn-id: http://code.djangoproject.com/svn/django/trunk@16972 bcc190cf-cafb-0310-a4f2-bffc1f526a37		2011-10-13 12:23:58 +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	Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0.	2010-07-24 10:21:21 +00:00
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	Added some sphinx cross-reference links to the built-in template tags and filters in multiple areas of the documentation. Also fixed a few minor inconsistencies and did a little PEP8 cleanup while I was at it.	2011-10-03 08:06:01 +00:00
internals	Fixed #15372 -- Switched to a startproject default layout that allows us to avoid sys.path hacks.	2011-10-13 05:56:15 +00:00
intro	Added note to tutorial part #2 about possible mismatch with the Django version being used regarding changes in location of django.conf.urls[.defaults] symbols. Thansk Carl for the suggestion.	2011-10-13 11:21:42 +00:00
man	Fixed #16099 -- Enabled threading for the runserver management command and added a --nothreading option to disable it if needed. This should help Google Chrome users because it opens more than one connection speculatively.	2011-06-17 13:08:36 +00:00
misc	Converted links to external topics so they use intersphinx extension markup.	2011-09-04 21:17:30 +00:00
obsolete	Fixed #14141 : docs now use the :doc: construct for links between documents.	2010-08-19 19:27:44 +00:00
ref	Fixed #7609 -- Noted in the model fields reference documentation that `PositiveIntegerField` accepts the value 0 for backwards-compatibility reasons. Thanks to everyone involved in the resolution of this issue, including Paul Collins for the patch.	2011-10-13 12:23:58 +00:00
releases	Fixed a missed typo in the 1.4 release notes. Oops.	2011-10-13 06:41:40 +00:00
topics	Removed a couple of notes associated with deprecated utilities from the localization document to unclutter it a bit.	2011-10-13 11:00:08 +00:00
Makefile	Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0.	2010-07-24 10:21:21 +00:00
README	Fixed #16414 -- Added standard Windows make batch file for Sphinx. Thanks, Aymeric Augustin.	2011-07-19 09:00:24 +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	Fixed #13397 - Include third level headings in the TOC. thanks cyang for the suggestion, rleland for the patch.	2010-12-27 23:58:16 +00:00
glossary.txt	Converted links to external topics so they use intersphinx extension markup.	2011-09-04 21:17:30 +00:00
index.txt	Fixed #16057 -- Extended deployment documentation with instructions for uWSGI. Thanks, jpic and aaugustin.	2011-06-16 16:34:12 +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

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/