mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-24 10:05:46 +00:00
Code Issues 25 Releases Wiki Activity
9d0bf66273
django/docs
History
Aymeric Augustin 9d0bf66273 Fixed #17316 -- Mentionned that the MultipleProxyMiddleware provided as an example must run rather early. 
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17556 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2012-02-19 08:09:20 +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 Fixed #17129 - Model FAQ: Link to south 2011-11-01 22:27:02 +00:00
howto Documentation (and some small source code) edits from [17432] - [17537] 2012-02-17 20:04:11 +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 #17706 - Improved short description example in Tutorial 2; thanks xbito and claudep. 2012-02-18 21:50: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
ref Fixed #17316 -- Mentionned that the MultipleProxyMiddleware provided as an example must run rather early. 2012-02-19 08:09:20 +00:00
releases Documentation (and some small source code) edits from [17432] - [17537] 2012-02-17 20:04:11 +00:00
topics Changed various non-breaking space characters from [17478] to use the code representation rather than the actual character, which is too hard to overlook because it just looks like a space 2012-02-17 20:23:42 +00:00
conf.py Bump version numbers for 1.4 beta 1. 2012-02-16 02:12:20 +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 #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
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/