django/docs
Aymeric Augustin 80c0cbf1c9 Clarified warning about date-based generic views. 2012-05-01 11:29:55 +02:00
..
_ext Replaced print statement by print function (forward compatibility syntax). 2012-04-30 20:45:03 +02:00
_theme/djangodocs Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0. 2010-07-24 10:21:21 +00:00
faq Updated some antique references in "Is Django stable?" 2012-04-28 15:16:46 -03:00
howto Replaced print statement by print function (forward compatibility syntax). 2012-04-30 20:45:03 +02:00
internals Fixed a small formatting error. 2012-04-30 17:50:32 +02:00
intro Replaced print statement by print function (forward compatibility syntax). 2012-04-30 20:45:03 +02: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 Fixed #18033 -- Removed function-based generic views, as per official deprecation timeline. Rest in peace! Thanks Anssi Kääriäinen for the review. 2012-04-25 19:17:47 +00:00
obsolete Fixed #14141: docs now use the :doc: construct for links between documents. 2010-08-19 19:27:44 +00:00
ref Clarified warning about date-based generic views. 2012-05-01 11:29:55 +02:00
releases Edited docs/releases/1.5.txt 2012-04-29 13:33:54 -05:00
topics Replaced print statement by print function (forward compatibility syntax). 2012-04-30 20:45:03 +02:00
Makefile Added gettext target to sphinx makefiles. 2012-04-07 22:35:57 +00:00
README Fixed #9995 -- Updated the installation instructions to recommend pip. Also fixed ReST errors. Refs #9112. 2012-03-03 09:11:54 +00:00
conf.py Removed a svn-specific configuration for Sphinx. 2012-04-28 15:03:16 +02: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 Fixed #18033 -- Removed function-based generic views, as per official deprecation timeline. Rest in peace! Thanks Anssi Kääriäinen for the review. 2012-04-25 19:17:47 +00:00
index.txt Fixed #18033 -- Removed function-based generic views, as per official deprecation timeline. Rest in peace! Thanks Anssi Kääriäinen for the review. 2012-04-25 19:17:47 +00:00
make.bat 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/