django

mirror of https://github.com/django/django.git synced 2025-01-11 19:06:26 +00:00

History

Jannis Leidel 127b7fdce8 Fixed #16469 -- Improved documentation of Django internals, including the new backport policy. Many thanks to Aymeric Augustin. git-svn-id: http://code.djangoproject.com/svn/django/trunk@16548 bcc190cf-cafb-0310-a4f2-bffc1f526a37		2011-07-19 13:16:09 +00:00
..
_ext
_theme/djangodocs
faq
howto	Fixed #15974 -- Correctly link to static files handling in deployment docs. Thanks, RogueBean.	2011-07-01 15:18:42 +00:00
internals	Fixed #16469 -- Improved documentation of Django internals, including the new backport policy. Many thanks to Aymeric Augustin.	2011-07-19 13:16:09 +00:00
intro	Fixed #16414 -- Added standard Windows make batch file for Sphinx. Thanks, Aymeric Augustin.	2011-07-19 09:00:24 +00:00
man	Fixed #16099 -- Enabled threading for the runserver management command and added a --nothreading option to disable it if needed. This should help Google Chrome users because it opens more than one connection speculatively.	2011-06-17 13:08:36 +00:00
misc
obsolete
ref	Added a note about the AJAX CSRF example not working on jQuery 1.5	2011-07-14 18:36:05 +00:00
releases	Fixed #5025 -- Add a "truncatechars" template filter. Many thanks to Chris Beaven.	2011-07-14 13:47:10 +00:00
topics	Grammar fixes and content tweaks to XSS section of security docs.	2011-07-17 14:17:26 +00:00
conf.py
contents.txt
glossary.txt
index.txt
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/