django/docs
Michael Schwarz 72d541b61c Fixed #27007 -- Handled non-UTF-8 bytes objects for text/* attachments.
The fallback logic which allows non-UTF-8 encoded files to be passed to
attach_file() even when a `text/*` mime type has been specified is
moved to attach(). Both functions now fall back to a content type of
`application/octet-stream`.

A side effect is that a file's content is decoded in memory instead of
opening it in text mode and reading it into a string.

Some mimetype-related logic in _create_attachment() has become
obsolete as the code moved from attach_file() to attach() already
handles this.
2016-08-12 16:35:09 -04:00
..
_ext Added copy-to-clipboard support for all code snippets 2016-07-06 17:11:59 +02:00
_theme Fixed many spelling mistakes in code, comments, and docs. 2015-12-03 12:48:24 -05:00
faq Fixed #26894 -- Fixed a typo in docs/faq/admin.txt 2016-07-14 08:02:11 -04:00
howto Removed extra periods in docs/howto/static-files/index.txt headers. 2016-07-27 13:50:31 -04:00
internals Fixed #26952 -- Added tips for installing test suite dependencies. 2016-08-09 18:37:09 -04:00
intro Fixed #26952 -- Added tips for installing test suite dependencies. 2016-08-09 18:37:09 -04:00
man Discouraged use of /tmp with predictable names. 2015-12-24 09:54:33 -05:00
misc Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
ref Fixed #20888 -- Added support for column order in class-based indexes. 2016-08-12 15:52:16 -04:00
releases Fixed #27007 -- Handled non-UTF-8 bytes objects for text/* attachments. 2016-08-12 16:35:09 -04:00
topics Fixed #27007 -- Handled non-UTF-8 bytes objects for text/* attachments. 2016-08-12 16:35:09 -04: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 Ignored new warnings when building the docs with Sphinx 1.4. 2016-06-01 11:03:41 -04:00
contents.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
glossary.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
index.txt Fixed #26709 -- Added class-based indexes. 2016-06-27 10:41:01 -04:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
spelling_wordlist Refs #26947 -- Added a deployment system check for SECURE_HSTS_PRELOAD. 2016-08-10 20:31:01 -04: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/