1
0
mirror of https://github.com/django/django.git synced 2025-04-15 04:44:37 +00:00
Duane Hilton 8c0851051d [1.6.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:39 -04:00
..
2013-01-25 13:58:37 -03:00

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