django

mirror of https://github.com/django/django.git synced 2024-12-26 02:56:25 +00:00

History

Luke Plant ac6361a3a6 Fixed some ReST errors in docs. git-svn-id: http://code.djangoproject.com/svn/django/trunk@16945 bcc190cf-cafb-0310-a4f2-bffc1f526a37		2011-10-08 18:07:30 +00:00
..
_ext	Fixed djangodocs Sphinx extension to work with latest Sphinx	2011-05-15 23:02:36 +00:00
_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	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 #16988 - Clean up the deprecation timeline for language consistency. Thanks ptone.	2011-10-06 17:31:18 +00:00
intro	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
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
ref	Fixed some ReST errors in docs.	2011-10-08 18:07:30 +00:00
releases	Fixed #17003 - prefetch_related should support foreign keys/one-to-one	2011-10-07 16:05:53 +00:00
topics	Fixed #17011 - Made override_settings modify a decorated class in-place rather than creating a dynamic subclass, so as to avoid infinite recursion when used with super(). Thanks jsdalton for the report and patch.	2011-10-08 08:16:17 +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 #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
Makefile
README	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/