1
0
mirror of https://github.com/django/django.git synced 2025-01-12 11:26:23 +00:00
django/docs
2011-02-02 20:57:09 +00:00
..
_ext
_theme/djangodocs
faq
howto Some tweaks to the staticfiles docs to clarify things for new users. Thanks Jannis and brutasse for review and discussion. 2011-01-31 22:06:53 +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 #15208 - Document ModelAdmin.formfield_for_choice_field; thanks julien. 2011-02-02 20:57:09 +00:00
releases Added note to 1.2.5 release notes about ModelAdmin.lookup_allowed change 2011-01-28 15:47:40 +00:00
topics Fixed #7325 -- Broken links for model documentation; thanks Justin Lilly. 2011-02-02 20:39:54 +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
glossary.txt
index.txt
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/