django

mirror of https://github.com/django/django.git synced 2024-11-30 07:06:18 +01:00

History

Luke Plant c61987d75a Removed use of non-standard indentation rules in docs, and the custom transform that supported them. Doc writers should be aware that we are now back to normal ReST rules regarding blockquotes. git-svn-id: http://code.djangoproject.com/svn/django/trunk@16955 bcc190cf-cafb-0310-a4f2-bffc1f526a37		2011-10-10 17:32:33 +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
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
misc
obsolete
ref	Removed use of non-standard indentation rules in docs, and the custom transform that supported them.	2011-10-10 17:32:33 +00:00
releases	Removed use of non-standard indentation rules in docs, and the custom transform that supported them.	2011-10-10 17:32:33 +00:00
topics	Removed use of non-standard indentation rules in docs, and the custom transform that supported them.	2011-10-10 17:32:33 +00:00
conf.py
contents.txt
glossary.txt
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/