django/docs
Tim Graham c6cd9f4ae2 Fixed typo in docs/releases/1.11.txt 2016-08-13 08:33:58 -04:00
..
_ext Added copy-to-clipboard support for all code snippets 2016-07-06 17:11:59 +02:00
_theme
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
misc
ref Fixed #27008 -- Added --debug-mode option to DiscoverRunner. 2016-08-12 20:43:17 -04:00
releases Fixed typo in docs/releases/1.11.txt 2016-08-13 08:33:58 -04:00
topics Fixed #27007 -- Handled non-UTF-8 bytes objects for text/* attachments. 2016-08-12 16:35:09 -04:00
Makefile
README
conf.py Ignored new warnings when building the docs with Sphinx 1.4. 2016-06-01 11:03:41 -04:00
contents.txt
glossary.txt
index.txt Fixed #26709 -- Added class-based indexes. 2016-06-27 10:41:01 -04:00
make.bat
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/