django/docs
Tim Graham cca302cde6 [1.4.x] Fixed #20887 -- Added a warning to GzipMiddleware in light of BREACH.
Thanks EvilDMP for the report and Russell Keith-Magee
for the draft text.

Backport of da843e7dba from master
2013-09-11 08:18:56 -04:00
..
_ext [1.4.x] Added a bugfix in docutils 0.11 -- docs will now build properly. 2013-07-31 10:14:38 -04:00
_theme/djangodocs [1.4.x] Addeded CSS to bold deprecation notices. 2013-01-09 19:05:20 -05:00
faq [1.4.X] Fixed #17511 - Removed reference to deprecated "reset" management command in FAQ; thanks voxpuibr@ for the report. 2012-06-27 18:56:04 -04:00
howto [1.4.x] Fixed #20756 -- Typo in uWSGI docs. 2013-07-17 06:51:48 -04:00
internals [1.4.x] Fixed #19196 -- Added test/requirements 2013-07-10 12:12:15 -04:00
intro [1.4.x] Fixed #19911 - Updated generic view links. 2013-02-25 13:01:15 -05:00
man [1.4.X] Fix lintian error in manpages. 2012-03-29 15:08:38 +00:00
misc [1.4.x] Fixed #19728 - Updated API stability doc to reflect current meaning of "stable". 2013-02-25 12:55:12 -05:00
obsolete Fixed #14141: docs now use the :doc: construct for links between documents. 2010-08-19 19:27:44 +00:00
ref [1.4.x] Fixed #20887 -- Added a warning to GzipMiddleware in light of BREACH. 2013-09-11 08:18:56 -04:00
releases Added 1.4.7 release notes 2013-09-10 21:09:47 -04:00
topics [1.4.x] Fixed #20887 -- Added a warning to GzipMiddleware in light of BREACH. 2013-09-11 08:18:56 -04:00
Makefile Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0. 2010-07-24 10:21:21 +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 [1.4.x] Bump version numbers for 1.4.7 security release. 2013-09-10 20:15:38 -05: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 Replaced http by https in djangoproject.com links 2012-03-13 17:53:31 +00:00
index.txt Replaced http by https in djangoproject.com links 2012-03-13 17:53:31 +00:00
make.bat Fixed #16414 -- Added standard Windows make batch file for Sphinx. Thanks, Aymeric Augustin. 2011-07-19 09:00:24 +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/