django/docs
Jannis Leidel f8a3d87a19 Fixed #16071 -- Added note to fix_ampersands documentation about its limitations. Many thanks to jerry and Julien Phalip.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@16431 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-06-17 15:39:35 +00:00
..
_ext Fixed djangodocs Sphinx extension to work with latest Sphinx 2011-05-15 23:02:36 +00:00
_theme/djangodocs
faq Fixed #16155 -- Removed Python 2.4 compatibility constructs from code and mentions from docs. Thanks Aymeric Augustin for the report and patch. 2011-06-09 20:01:28 +00:00
howto Fixed #16057 -- Extended deployment documentation with instructions for uWSGI. Thanks, jpic and aaugustin. 2011-06-16 16:34:12 +00:00
internals Fixed #16155 -- Removed Python 2.4 compatibility constructs from code and mentions from docs. Thanks Aymeric Augustin for the report and patch. 2011-06-09 20:01:28 +00:00
intro Fixed #16155 -- Removed Python 2.4 compatibility constructs from code and mentions from docs. Thanks Aymeric Augustin for the report and patch. 2011-06-09 20:01:28 +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 Fixed #16071 -- Added note to fix_ampersands documentation about its limitations. Many thanks to jerry and Julien Phalip. 2011-06-17 15:39:35 +00:00
releases Fixed #16255 -- Raised minimum PostgreSQL version supported to 8.2. 2011-06-16 20:05:25 +00:00
topics Fixed #16126 -- Added documentation about DELETE and ORDER fields in formsets. Many thanks to Aleksandra Sendecka. 2011-06-17 15:39:28 +00:00
Makefile
README Added a README for building offline HTML docs. 2010-11-06 17:44:26 +00:00
conf.py
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 Fixed #16057 -- Extended deployment documentation with instructions for uWSGI. Thanks, jpic and aaugustin. 2011-06-16 16:34:12 +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`` 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/