django/docs
Tim Graham 3a829bf75a [1.5.x] Added some doc links for django.contrib.messages
Backport of b6178fa24b from master
2013-08-14 13:05:30 -04:00
..
_ext [1.5.x] Added a bugfix in docutils 0.11 -- docs will now build properly. 2013-07-31 09:26:23 -04: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 #15379 - Added "how to cite Django" to FAQ. 2013-03-29 16:50:33 -04:00
howto [1.5.x] Fixed #20756 -- Typo in uWSGI docs. 2013-07-17 06:51:42 -04:00
internals [1.5.x] Fixed #20868 -- Added an email to django-announce as a security step. 2013-08-09 16:02:57 -04:00
intro [1.5.x] Fixed #20763 -- Typo in tutorial 3. 2013-07-18 08:05:06 -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] Added some doc links for django.contrib.messages 2013-08-14 13:05:30 -04:00
releases Added 1.4.6/1.5.2 release notes. 2013-08-13 11:17:17 -05:00
topics [1.5.x] Fixed #20890 -- Added missing import in class-based view docs. 2013-08-10 18:08:33 -04:00
Makefile [1.5.x] Allowed overriding variables in docs/Makefile. 2013-07-29 06:52:50 -04:00
README Fixed #18928. Tightened language in docs/README. 2012-09-08 11:11:37 +05:30
conf.py Bumped version numbers for 1.5.2. 2013-08-13 11:10:05 -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 [1.5.x] Fixed #19897 - Updated static files howto. 2013-03-30 07:12:37 -04: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/