1
0
mirror of https://github.com/django/django.git synced 2025-01-11 10:56:28 +00:00
django/docs
2011-08-13 13:51:34 +00:00
..
_ext
_theme/djangodocs
faq
howto Fixed #15252 -- Added static template tag and CachedStaticFilesStorage to staticfiles contrib app. 2011-08-11 14:07:39 +00:00
internals Fixed #16469 -- Improved documentation of Django internals, including the new backport policy. Many thanks to Aymeric Augustin. 2011-07-19 13:16:09 +00:00
intro Fixed #16414 -- Added standard Windows make batch file for Sphinx. Thanks, Aymeric Augustin. 2011-07-19 09:00:24 +00:00
man
misc
obsolete
ref Fixed #6644 -- Fixed django.contrib.formtools tests to be better isolated when running outside of the Django test suite. Also moved around the new wizard's templates a bit to better fit the common app layout. 2011-08-13 13:51:34 +00:00
releases Fixed #16621 -- Fixed lots of typos in the docs. Thanks, Bernhard Essl. 2011-08-13 11:58:19 +00:00
topics Fixed #16621 -- Fixed lots of typos in the docs. Thanks, Bernhard Essl. 2011-08-13 11:58:19 +00:00
conf.py
contents.txt
glossary.txt
index.txt
make.bat Fixed #16414 -- Added standard Windows make batch file for Sphinx. Thanks, Aymeric Augustin. 2011-07-19 09:00:24 +00:00
Makefile
README Fixed #16414 -- Added standard Windows make batch file for Sphinx. Thanks, Aymeric Augustin. 2011-07-19 09:00:24 +00:00

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/