django/docs
Duane Hilton f0e7a695f5 [1.7.x] Fixed #17638 -- Added crosslinks between topic and reference guides.
Thanks oinopion for the suggestion and jarus for the initial patch.

Backport of 054bdfeff1 from master
2014-09-29 18:17:13 -04:00
..
_ext [1.7.x] Added sphinx extension to ease generation of ticket links. 2014-08-19 17:45:59 -04:00
_theme [1.7.x] Removed duplicate "Deprecated in Django A.B" text in docs. 2014-06-07 07:25:02 -04:00
faq [1.7.x] Fixed #23016 -- Updated FAQs per Aymeric's suggestions. 2014-08-12 13:48:21 -04:00
howto [1.7.x] Fixed #23530 -- Specified PyYAML requirement in initial-data.txt 2014-09-21 16:05:26 +02:00
internals [1.7.x] Fixed #23414 -- Updated version numbers in release process doc. 2014-09-05 15:44:56 -04:00
intro [1.7.x] Fixed #23535 -- Updated tutorial to account for default filter added in 5ea34f3f86. 2014-09-22 15:24:48 -04:00
man Removed a man page for a command that was removed 2014-01-10 15:23:06 -08:00
misc Fixed #16785 -- Documented some of the design decisions of the cache framework. 2014-01-16 21:13:08 -05:00
ref [1.7.x] Fixed #17638 -- Added crosslinks between topic and reference guides. 2014-09-29 18:17:13 -04:00
releases [1.7.x] Fixed #23560 -- Fixed MigrationWrite to handle builtin types without imports. 2014-09-27 00:40:35 +07:00
topics [1.7.x] Fixed #17638 -- Added crosslinks between topic and reference guides. 2014-09-29 18:17:13 -04:00
Makefile Fixed #22141 -- Added a spelling checker for documentation. 2014-03-07 09:29:23 -05:00
README Whitespace cleanup. 2013-10-10 16:49:20 -04:00
conf.py [1.7.x] Added sphinx extension to ease generation of ticket links. 2014-08-19 17:45:59 -04:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt Fixed some typos in the documentation. 2014-03-02 17:05:57 +01:00
index.txt [1.7.x] Fixed #22812 -- Refactored lookup API documentation. 2014-07-08 20:13:24 -04:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
spelling_wordlist [1.7.x] Fixed #22796 -- Added a more basic explanations of forms. 2014-06-24 14:58:53 -04:00

README

The documentation in this tree is in plain text files and can be viewed using
any text file viewer.

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-doc.org/