django

History

Gabriel Hurley 920d01edb7 Fixed #16660 -- Corrected a typo and removed an extra space in the GeoDjango tutorial. Thanks to spahn for the report. git-svn-id: http://code.djangoproject.com/svn/django/trunk@16627 bcc190cf-cafb-0310-a4f2-bffc1f526a37		2011-08-19 18:18:06 +00:00
..
_ext	Fixed djangodocs Sphinx extension to work with latest Sphinx	2011-05-15 23:02:36 +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 #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 #15252 -- Added static template tag and CachedStaticFilesStorage to staticfiles contrib app.	2011-08-11 14:07:39 +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	Changed e-mail to email throughout documentation and codebase. The one exception is translation strings, which I didn't want to disrupt	2011-04-01 16:10:22 +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 #16660 -- Corrected a typo and removed an extra space in the GeoDjango tutorial. Thanks to spahn for the report.	2011-08-19 18:18:06 +00:00
releases	Fixed #16621 -- Fixed lots of typos in the docs. Thanks, Bernhard Essl.	2011-08-13 11:58:19 +00:00
topics	Fixed #16608 -- Clarified the description of the destroy_test_db method and cleaned up various other reST/Sphinx-related bits in the testing docs. Thanks to Stan for the report and Julien for the draft patch.	2011-08-18 22:31:32 +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	Bumped django_next_version so that "New in Django 1.3" links appear correctly.	2011-03-24 09:40:50 +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	Minor markup and organization fixes to docs to correct Sphinx errors.	2011-03-22 14:35:14 +00:00
index.txt	Fixed #16057 -- Extended deployment documentation with instructions for uWSGI. Thanks, jpic and aaugustin.	2011-06-16 16:34:12 +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/