1
0
mirror of https://github.com/django/django.git synced 2024-12-24 10:05:46 +00:00
django/docs
2011-01-22 12:43:50 +00:00
..
_ext Reformated some code for readability. 2010-11-20 21:00:41 +00:00
_theme/djangodocs
faq
howto Refs #14661 -- Clarified the handling of initial data injected via custom SQL. 2011-01-18 16:43:01 +00:00
internals Update contributing documentation for changed translation policy. 2011-01-21 19:37:16 +00:00
intro Fixed #15057 - documented change in [14992] 2011-01-13 13:47:21 +00:00
man Fixed #7735 -- Added support for IPv6 adresses to runserver and testserver management command. Thanks to Jason Alonso and Łukasz Rekucki for the report and initial patches. 2010-11-26 13:33:53 +00:00
misc
obsolete
ref Fixed #15133 - Some markup issues in the docs; thanks Aryeh Leib Taurog for the report. 2011-01-22 12:43:50 +00:00
releases Fixed #15133 - Some markup issues in the docs; thanks Aryeh Leib Taurog for the report. 2011-01-22 12:43:50 +00:00
topics Fixed #15133 - Some markup issues in the docs; thanks Aryeh Leib Taurog for the report. 2011-01-22 12:43:50 +00:00
conf.py Removed compatibility with Sphinx < 1.0 workarounds in our extension code. Also, started to use the 'needs_sphinx' Sphinx config var. 2010-11-19 23:19:56 +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/