django/docs
Tim Graham 7206330c15 [1.5.x] Fixed #17935 - Clarified intro of topics/files.txt.
Thanks guettli for the suggestion.

Backport of f7795e968d from master
2013-03-22 07:44:42 -04:00
..
_ext [1.5.x] Fixed #19699 - Removed "Please see the release notes" from versionadded/changed directives 2013-02-09 09:22:33 -05:00
_theme/djangodocs [1.5.x] Addeded CSS to bold deprecation notices. 2013-01-09 19:05:00 -05:00
faq [1.5.x] Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:50:00 -05:00
howto [1.5.x] Fixed #19749 -- Documented ending param to command's self.stdout/err 2013-02-09 10:19:59 +01:00
internals [1.5.x] Fixed #19333 -- Moved compress.py outside of the admin static folder. Thanks to camilonova, Russell Keith-Magee, Aymeric Augustin and Ramiro Morales for the feedback. 2013-02-02 15:03:05 -08:00
intro [1.5.x] Fixed #20051 -- Specified where to define `TEMPLATE_DIRS`. 2013-03-18 15:48:47 -04: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 [1.5.X] Fixed #19728 - Updated API stability doc to reflect current meaning of "stable". 2013-02-19 18:20:46 -05:00
ref [1.5.x] Fixed #20096 -- Added link to the Greek localflavor app 2013-03-20 17:11:21 +01:00
releases [1.5.x] Add release date to 1.5 release notes. 2013-02-26 13:12:27 -06:00
topics [1.5.x] Fixed #17935 - Clarified intro of topics/files.txt. 2013-03-22 07:44:42 -04:00
Makefile [1.5.x] Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:50:00 -05:00
README Fixed #18928. Tightened language in docs/README. 2012-09-08 11:11:37 +05:30
conf.py [1.5.x] Bump version numbers for Django 1.5 release. 2013-02-26 13:06:35 -06: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 [1.5.x] Added more shortcuts to i18n docs in index page. 2013-01-25 20:43:21 -03:00
make.bat [1.5.x] Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:50:00 -05:00

README

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/