django1

History

Timo Graham ce4cd788ef Fixed #17757 - Typo in docs/intro/overview.txt; thanks kaushik1618. git-svn-id: http://code.djangoproject.com/svn/django/trunk@17584 bcc190cf-cafb-0310-a4f2-bffc1f526a37		2012-02-24 22:53:48 +00:00
..
_ext	Fixed #17526 - unnecessary comma in 'Please, see the release notes' removed	2012-01-11 10:19:05 +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 #17129 - Model FAQ: Link to south	2011-11-01 22:27:02 +00:00
howto	Fixed #17166 -- Documented how FIXTURE_DIRS works in the inital data how-to, and edited related bits in the settings reference.	2012-02-19 09:02:52 +00:00
internals	Added note to coding-style.txt about how we should NOT be religious about line lengths.	2012-02-17 20:03:40 +00:00
intro	Fixed #17757 - Typo in docs/intro/overview.txt; thanks kaushik1618.	2012-02-24 22:53:48 +00:00
man	Fixed a couple of minor errors in the django-admin(1) Unix man page.	2012-02-06 02:00:19 +00:00
misc	Fixed many more ReST indentation errors, somehow accidentally missed from [16955]	2011-10-14 00:12:01 +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 #17749 - Documented better way of overriding ModelAdmin; thanks chrisdpratt and claudep.	2012-02-24 22:50:36 +00:00
releases	Fixed #17660 -- Standardize extends tag token parsing	2012-02-21 02:59:05 +00:00
topics	Fixed #17390 - Added a note to topics/auth.txt regarding how to decorate class-based generic views; thanks zsiciarz for the patch.	2012-02-20 18:57:51 +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	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	Converted links to external topics so they use intersphinx extension markup.	2011-09-04 21:17:30 +00:00
index.txt	Fixed #16277 -- Changed the link to the IRC logs.	2011-11-25 19:40:46 +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/