1
0
mirror of https://github.com/django/django.git synced 2024-12-25 02:26:12 +00:00
django/docs
2011-05-14 17:44:10 +00:00
..
_ext Fixed our Sphinx extension to work with latest Sphinx 2011-05-14 02:58:58 +00:00
_theme/djangodocs
faq Fixed #14091 - be more correct about logging queries in connection.queries. 2011-04-22 12:14:54 +00:00
howto Fixed #16014 -- numerous documentation typos -- thanks psmith. 2011-05-13 04:33:42 +00:00
internals Fixed #16014 -- numerous documentation typos -- thanks psmith. 2011-05-13 04:33:42 +00:00
intro Fixed #16014 -- numerous documentation typos -- thanks psmith. 2011-05-13 04:33:42 +00:00
man
misc Changed e-mail to email throughout documentation and codebase. The one exception is translation strings, which I didn't want to disrupt 2011-04-01 16:10:22 +00:00
obsolete
ref Tweaked weird wording of docs/ref/contrib/humanize.txt 'naturaltime' section from [16071] 2011-05-14 17:44:10 +00:00
releases Fixed #16014 -- numerous documentation typos -- thanks psmith. 2011-05-13 04:33:42 +00:00
topics Removed last vestiges of references to technical messages from documentation. 2011-05-14 12:28:36 +00:00
conf.py
contents.txt
glossary.txt
index.txt Changed e-mail to email throughout documentation and codebase. The one exception is translation strings, which I didn't want to disrupt 2011-04-01 16:10:22 +00:00
Makefile
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/