django

mirror of https://github.com/django/django.git synced 2024-12-23 09:36:06 +00:00

History

Julien Phalip c2b9f6496e 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. git-svn-id: http://code.djangoproject.com/svn/django/trunk@16922 bcc190cf-cafb-0310-a4f2-bffc1f526a37		2011-10-03 08:06:01 +00:00
..
_ext
_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 #16907 (again) -- Added deprecation of databrowse to the deprecation docs.	2011-09-22 22:44:00 +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
misc	Converted links to external topics so they use intersphinx extension markup.	2011-09-04 21:17:30 +00:00
obsolete
ref	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
releases	Fixed #10841 -- Switched response served when DEBUG=True and request.is_ajax() returns True (indicating request has been generated by a JS library) to a plain text version for easier debugging.	2011-10-02 02:53:58 +00:00
topics	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
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
make.bat
Makefile
README

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/