django/docs
Alex Gaynor 79ce1be26b Fix a reST error.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17852 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2012-03-31 16:30:36 +00:00
..
_ext Fixed #17526 - unnecessary comma in 'Please, see the release notes' removed 2012-01-11 10:19:05 +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 #18029 -- Removed mod_python as of deprecation process. Thanks Aymeric Augustin for the review. 2012-03-31 10:34:11 +00:00
howto Fix a reST error. 2012-03-31 16:30:36 +00:00
internals Fixed #17965 -- Definitely dropped support for Python 2.5. Thanks jonash for the initial patch and Aymeric Augustin for the review. 2012-03-31 08:24:29 +00:00
intro Fixed #17965 -- Definitely dropped support for Python 2.5. Thanks jonash for the initial patch and Aymeric Augustin for the review. 2012-03-31 08:24:29 +00:00
man Removed the deprecated reset and sqlreset management commands. 2012-03-31 12:38:11 +00:00
misc Replaced http by https in djangoproject.com links 2012-03-13 17:53:31 +00:00
obsolete Fixed #14141: docs now use the :doc: construct for links between documents. 2010-08-19 19:27:44 +00:00
ref Removed deprecated URLField.verify_exists. 2012-03-31 13:55:03 +00:00
releases Fixed #17965 -- Definitely dropped support for Python 2.5. Thanks jonash for the initial patch and Aymeric Augustin for the review. 2012-03-31 08:24:29 +00:00
topics Removed deprecated URLField.verify_exists. 2012-03-31 13:55:03 +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 #9995 -- Updated the installation instructions to recommend pip. Also fixed ReST errors. Refs #9112. 2012-03-03 09:11:54 +00:00
conf.py Bump trunk to 1.4. 2012-03-23 16:53:23 +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 Replaced http by https in djangoproject.com links 2012-03-13 17:53:31 +00:00
index.txt Fixed #18029 -- Removed mod_python as of deprecation process. Thanks Aymeric Augustin for the review. 2012-03-31 10:34:11 +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:

* Install Sphinx (using ``sudo pip 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/