1
0
mirror of https://github.com/django/django.git synced 2025-01-12 03:15:47 +00:00
django/docs
2011-02-18 22:42:37 +00:00
..
_ext
_theme/djangodocs
faq
howto Fixed #15310 -- Corrected a view path in the static files how to docs. Thanks to Bradley Ayers for the report and patch. 2011-02-17 02:11:44 +00:00
internals Fixed #13662 -- Added an entry in the README to direct people to the instructions for running the test suite, and cleaned up that section of the docs. Thanks to mir for the report, and to cogat and gg for the draft text. 2011-01-27 03:14:49 +00:00
intro Fixed #15153 - removed obsolete sentence in tutorial; thanks LeSphinx for the report. 2011-01-26 00:58:41 +00:00
man
misc
obsolete
ref Fixed #15335 -- Improved Sphinx crossref targets and metadata for the sites and flatpages reference docs. 2011-02-18 00:58:34 +00:00
releases Fixed "the the" typos. 2011-02-14 23:18:30 +00:00
topics Fixed #15347 -- Corrected a typo in the l10n docs. Thanks to RaceCondition for the report. 2011-02-18 22:42:37 +00:00
conf.py Fixed #15196 -- Bumped version up a bit in Sphinx configuration. Thanks, Eric Holscher. 2011-01-30 20:31:39 +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
index.txt Fixed #6181 - Document django.views.decorators.http - thanks adamv for the patch. 2010-12-27 13:27:26 +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/