1
0
mirror of https://github.com/django/django.git synced 2024-12-24 01:55:49 +00:00
django/docs
2012-12-29 18:52:50 -05:00
..
_ext Made more extensive usage of context managers with open. 2012-05-05 14:06:36 +02:00
_theme/djangodocs Fixed #19317 - Added an image for warning blocks in the docs 2012-11-22 06:34:15 -05:00
faq Updated installation FAQ entry on Python versions. 2012-12-25 00:26:46 +01:00
howto Removed versionadded/changed annotations dating back to 1.4. 2012-12-29 21:59:08 +01:00
internals Removed links to deprecated IGNORABLE_404_STARTS/ENDS settings. 2012-12-29 18:52:50 -05:00
intro Fixed broken links, round 3. refs #19516 2012-12-26 19:07:22 -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 Removed django.contrib.localflavor. 2012-12-29 21:59:06 +01:00
ref Removed versionadded/changed annotations dating back to 1.4. 2012-12-29 21:59:08 +01:00
releases Removed links to deprecated IGNORABLE_404_STARTS/ENDS settings. 2012-12-29 18:52:50 -05:00
topics Removed versionadded/changed annotations dating back to 1.4. 2012-12-29 21:59:08 +01:00
conf.py Fixed broken links, round 3. refs #19516 2012-12-26 19:07:22 -05:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt Fixed #18451 -- Vastly improved class based view documentation. 2012-06-11 10:40:23 +02:00
index.txt Removed django.contrib.localflavor. 2012-12-29 21:59:06 +01:00
make.bat Fixed #19266 -- Added Texinfo documentation target 2012-11-09 09:00:27 +01:00
Makefile Fixed #19266 -- Added Texinfo documentation target 2012-11-09 09:00:27 +01:00
README Fixed #18928. Tightened language in docs/README. 2012-09-08 11:11:37 +05:30

The documentation in this tree is in plain text files and can be viewed using
any text file viewer.

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/