django

History

Carl Meyer 00678334aa Fixed #16863 -- Corrected ReST markup to avoid errors building docs. Although directives such as "note" and "warning" will accept content immediately following the directive, this is technically where arguments to the directive should go (see http://sphinx.pocoo.org/rest.html#directives). Putting the content there means that any lines beginning with an inline text role (e.g. ":setting:`DEBUG`") will be mis-interpreted as an option block for the directive. To avoid this error, there should always be a blank line between the directive start and the directive content. git-svn-id: http://code.djangoproject.com/svn/django/trunk@16842 bcc190cf-cafb-0310-a4f2-bffc1f526a37		2011-09-16 18:06:42 +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 typo in PEP number introduced in last commit. Thanks Jannis for the eagle eyes.	2011-09-04 22:42:11 +00:00
howto	Fixed #16863 -- Corrected ReST markup to avoid errors building docs.	2011-09-16 18:06:42 +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	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 #16863 -- Corrected ReST markup to avoid errors building docs.	2011-09-16 18:06:42 +00:00
releases	Added release note and updated TEMPLATE_DEBUG documentation for r16833. Thanks jezdez for the reminder.	2011-09-16 17:07:19 +00:00
topics	Fixed #16863 -- Corrected ReST markup to avoid errors building docs.	2011-09-16 18:06:42 +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/