django/docs
Claude Paroz beb392b85e [1.8.x] Added safety to URL decoding in is_safe_url() on Python 2
The errors='replace' parameter to force_text altered the URL before checking
it, which wasn't considered sane. Refs 24fc935218 and ada7a4aef.
Backport of 552f03869e from master.
2016-03-04 23:39:46 +01:00
..
_ext [1.8.x] Fixed #23751 -- Fixed code snippet formatting in docs PDF. 2015-11-16 20:32:51 -05:00
_theme [1.8.x] Fixed many spelling mistakes in code, comments, and docs. 2016-02-23 10:27:15 -05:00
faq [1.8.x] Fixed #25881 -- Marked Python 3.2 in Django 1.8 as unsupported at the end of 2016. 2015-12-08 12:48:07 -05:00
howto [1.8.x] Followed recommended ValidationError use in docs. 2016-02-17 09:10:09 -05:00
internals [1.8.x] Fixed #26309 -- Documented that login URL settings no longer support dotted paths. 2016-03-03 07:49:06 -05:00
intro [1.8.x] Fixed #26221 -- Used find_packages() in reusable apps tutorial. 2016-02-15 19:25:53 -05:00
man [1.8.x] Discouraged use of /tmp with predictable names. 2015-12-24 09:57:02 -05:00
misc Fixed #16785 -- Documented some of the design decisions of the cache framework. 2014-01-16 21:13:08 -05:00
ref [1.8.x] Fixed #26321 -- Added missing "for_save" parameter in expressions example. 2016-03-03 19:38:06 -05:00
releases [1.8.x] Added safety to URL decoding in is_safe_url() on Python 2 2016-03-04 23:39:46 +01:00
topics [1.8.x] Fixed CVE-2016-2513 -- Fixed user enumeration timing attack during login. 2016-02-29 08:07:17 -05:00
Makefile Added an "htmlview" target to open docs after building them. 2014-12-08 07:23:34 -05:00
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
conf.py [1.8.x] Fixed many spelling mistakes in code, comments, and docs. 2016-02-23 10:27:15 -05:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt [1.8.x] Updated Wikipedia links to use https 2015-08-08 12:09:53 +02:00
index.txt [1.8.x] Changed section title from "Model syntax" to "Introduction to models". 2015-11-16 09:54:30 -05:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
spelling_wordlist [1.8.x] Fixed #26267 -- Fixed BoundField to reallow slices of subwidgets. 2016-02-24 07:09:08 -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 ``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-doc.org/