django

History

Malcolm Tredinnick 1154b80a64 Added placeholder release notes for the 1.2.1 and 1.2.3 releases. Both of these releases were to fix bugs in the previous release and, as such contained nothing new of significance. However, to complete the set of release note files in case anybody worries about the gaps, we now have documents explaining precisely that. Fixed #15330. git-svn-id: http://code.djangoproject.com/svn/django/trunk@16695 bcc190cf-cafb-0310-a4f2-bffc1f526a37		2011-08-26 09:31:01 +00:00
..
_ext	Fixed djangodocs Sphinx extension to work with latest Sphinx	2011-05-15 23:02:36 +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 #16155 -- Removed Python 2.4 compatibility constructs from code and mentions from docs. Thanks Aymeric Augustin for the report and patch.	2011-06-09 20:01:28 +00:00
howto	Fixed #15252 -- Added static template tag and CachedStaticFilesStorage to staticfiles contrib app.	2011-08-11 14:07:39 +00:00
internals	Add a note about discouraging whitespace- or formatting-only patches.	2011-08-26 05:28:58 +00:00
intro	Fixed #16669 -- Made the startproject instruction formatting easier to read and more consistent with other formatting in the tutorial part 1. Thanks to Daniel Lawrence and Aymeric Augustin.	2011-08-23 05:24:31 +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	Changed e-mail to email throughout documentation and codebase. The one exception is translation strings, which I didn't want to disrupt	2011-04-01 16:10:22 +00:00
obsolete	Fixed #14141 : docs now use the :doc: construct for links between documents.	2010-08-19 19:27:44 +00:00
ref	Clarify the documentation around SQLite and case-sensitive string matching.	2011-08-26 08:42:38 +00:00
releases	Added placeholder release notes for the 1.2.1 and 1.2.3 releases.	2011-08-26 09:31:01 +00:00
topics	Fixed documentation about use of salt parameter in signing functions.	2011-08-26 08:18:05 +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	Bumped django_next_version so that "New in Django 1.3" links appear correctly.	2011-03-24 09:40:50 +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	Minor markup and organization fixes to docs to correct Sphinx errors.	2011-03-22 14:35:14 +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/