django

mirror of https://github.com/django/django.git synced 2024-11-29 22:56:46 +01:00

History

Aymeric Augustin af71ce06ea Minor fixes in the custom template tags docs.		2012-04-29 21:44:31 +02:00
..
_ext	Fixed #18023 -- Removed bundled simplejson.	2012-04-29 19:58:00 +02:00
_theme/djangodocs
faq	Updated some antique references in "Is Django stable?"	2012-04-28 15:16:46 -03:00
howto	Minor fixes in the custom template tags docs.	2012-04-29 21:44:31 +02:00
internals	Fixed #18220 -- Removed the CACHE_BACKEND setting, as per official deprecation timeline.	2012-04-29 20:47:36 +02:00
intro	Updated docs/intro/whatsnext.txt to reference Git instead of SVN	2012-04-27 22:57:23 -05: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
ref	Fixed #18013 -- Use the new 'as' syntax for exceptions.	2012-04-29 20:57:15 +02:00
releases	Edited docs/releases/1.5.txt	2012-04-29 13:33:54 -05:00
topics	Fixed #18023 -- Removed bundled simplejson.	2012-04-29 19:58:00 +02:00
conf.py	Removed a svn-specific configuration for Sphinx.	2012-04-28 15:03:16 +02:00
contents.txt
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
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

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/