mirror of
https://github.com/django/django.git
synced 2025-01-22 08:10:28 +00:00
4c8f2dca21
Been meaning to do this for a long time. Mostly, this is a lot of additions of cross references. Within a particular section about foo() I didn't cross-link foo() calls to itself, but everything else was cross-linked to its main documentation. git-svn-id: http://code.djangoproject.com/svn/django/trunk@16699 bcc190cf-cafb-0310-a4f2-bffc1f526a37
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/