django

History

Timo Graham ba21814583 Fixes #14743 - Add sphinx links and other cleanups to topics/http/urls.txt. Thanks adamv for the patch. git-svn-id: http://code.djangoproject.com/svn/django/trunk@14705 bcc190cf-cafb-0310-a4f2-bffc1f526a37		2010-11-26 13:01:56 +00:00
..
_ext	Reformated some code for readability.	2010-11-20 21:00:41 +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 #10904 -- Corrected inappropriate usage of the term "absolute URL" throughout the docs. Replaced with the (RFC 2396-compliant) terms "absolute path reference" or "absolute path" as appropriate for the context. Thanks to sharan666 for the report, and Malcolm, Chris, and dwillis for their work in supplying a solution and patch.	2010-11-07 01:42:55 +00:00
howto	Clarified a comment in the mod_python docs on the status of the handler. Thanks to mattmcc for the report.	2010-11-22 12:29:22 +00:00
internals	Add myself to committers	2010-11-26 12:30:25 +00:00
intro	Fixes #6739 -- better development installation docs. Thanks to Adam Vandenberg for inspiration.	2010-11-23 03:54:13 +00:00
man	Fixed #14693 , #14709 -- Backwards incompatible change to rectify the confusion around the STATICFILES_URL and STATICFILES_ROOT settings.	2010-11-17 15:36:26 +00:00
misc	Fixed #14455 -- Documented the backwards compatibility policy for local flavors. Implemented the policy for the changes in the Indonesian local flavor (from r14195) that stimulated the development of this policy. Thanks to Karen, Alex, Ramiro and Chris for their help developing the policy.	2010-11-01 00:52:58 +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 #14756 - fix typo in "related objects reference" docs. Thanks deisner for the report.	2010-11-26 12:40:09 +00:00
releases	Clarified the text describing the deprecation status of mod_python. Thanks to mattmcc and Tai Lee for pointing out the ambiguity.	2010-11-22 12:13:18 +00:00
topics	Fixes #14743 - Add sphinx links and other cleanups to topics/http/urls.txt. Thanks adamv for the patch.	2010-11-26 13:01:56 +00:00
Makefile	Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0.	2010-07-24 10:21:21 +00:00
README	Added a README for building offline HTML docs.	2010-11-06 17:44:26 +00:00
conf.py	Removed compatibility with Sphinx < 1.0 workarounds in our extension code. Also, started to use the 'needs_sphinx' Sphinx config var.	2010-11-19 23:19:56 +00:00
contents.txt	Added a hidden toctree pointing at the index file in the docs to silence a sphinx warning.	2010-11-17 20:26:20 +00:00
glossary.txt	Fixed #14141 : docs now use the :doc: construct for links between documents.	2010-08-19 19:27:44 +00:00
index.txt	Fixed #14641 - a handful of grammer/typo fixes.	2010-11-08 20:37:52 +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/