1
0
mirror of https://github.com/django/django.git synced 2024-12-23 17:46:27 +00:00
django/docs
2012-04-23 18:05:12 +00:00
..
_ext
_theme/djangodocs
faq Fixed #18029 -- Removed mod_python as of deprecation process. Thanks Aymeric Augustin for the review. 2012-03-31 10:34:11 +00:00
howto Fixed #18187 -- Completed example and details about custom command options. Thanks purple for the report. 2012-04-23 18:05:12 +00:00
internals
intro Reworded the 'Set up a database' section of the installation docs. 2012-04-21 12:35:06 +00:00
man Fixed #18035 -- Removed deprecated AdminMediaHandler, as per official deprecation timeline. Thanks Jannis Leidel and Ramiro Morales for the review. 2012-04-08 21:13:32 +00:00
misc
obsolete
ref Fixed #5893 -- Added a flag to FilePathField to allow listing folders, in addition to regular files. Thank you to Brian Rosner, for encouraging me to first contribute to Django 4 years ago. 2012-04-22 14:44:08 +00:00
releases Fixed #18078 -- Linked more prominently to the removed features in the release notes. Thanks ptone for the text. 2012-04-14 06:40:20 +00:00
topics Fixed #18159 -- added an import statement to the docs. Thanks to Jeff Hui for the patch. 2012-04-22 15:58:53 +00:00
conf.py Advanced version identifiers for 1.5 development cycle. 2012-03-31 19:39:28 +00:00
contents.txt
glossary.txt
index.txt Fixed #18029 -- Removed mod_python as of deprecation process. Thanks Aymeric Augustin for the review. 2012-03-31 10:34:11 +00:00
make.bat Added gettext target to sphinx makefiles. 2012-04-07 22:35:57 +00:00
Makefile Added gettext target to sphinx makefiles. 2012-04-07 22:35:57 +00:00
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:

* Install Sphinx (using ``sudo pip 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/