django

History

Aymeric Augustin 9d7b5558ee Fixed a few typos and updated an example in the URLs docs. git-svn-id: http://code.djangoproject.com/svn/django/trunk@17537 bcc190cf-cafb-0310-a4f2-bffc1f526a37		2012-02-16 21:59:22 +00:00
..
_ext	Fixed #17526 - unnecessary comma in 'Please, see the release notes' removed	2012-01-11 10:19:05 +00:00
_theme/djangodocs	…
faq	…
howto	…
internals	Used Sphinx markup for PEPs and fixed a typo in the 1.4-beta-1 release notes.	2012-02-16 18:27:42 +00:00
intro	…
man	…
misc	…
obsolete	Fixed #14141 : docs now use the :doc: construct for links between documents.	2010-08-19 19:27:44 +00:00
ref	Fixed #17693 . Input validation and tests for base36 conversion utils. Thanks Keryn Knight for the report.	2012-02-16 00:58:49 +00:00
releases	…
topics	Fixed a few typos and updated an example in the URLs docs.	2012-02-16 21:59:22 +00:00
Makefile	Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0.	2010-07-24 10:21:21 +00:00
README	…
conf.py	Bump version numbers for 1.4 beta 1.	2012-02-16 02:12:20 +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	…
index.txt	…
make.bat	…

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/