django/docs
Cammil Taank f83a689f61 Fixed #29758 -- Documented how to test custom error views. 2018-10-01 18:16:47 -04:00
..
_ext Updated contributing tutorial's virtual environment instructions. 2018-09-19 14:37:44 -04:00
_theme Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 13:00:34 -04:00
faq Fixed #29261 -- Doc'd the reason for LICENSE.python. 2018-06-29 20:00:58 -04:00
howto Refs #29784 -- Switched to https:// links where available. 2018-09-26 08:48:47 +02:00
internals Refs #29784 -- Switched to https:// links where available. 2018-09-26 08:48:47 +02:00
intro Updated contributing tutorial's virtual environment instructions. 2018-09-19 14:37:44 -04:00
man Updated man page for Django 2.1 alpha. 2018-05-17 09:30:20 -04:00
misc Updated various links in docs to avoid redirects 2017-05-22 19:28:44 +02:00
ref Added tests for using bytearray with BinaryField and corrected docs. 2018-10-01 09:16:16 -04:00
releases Adjusted text for CVE-2018-16984 in security release archive. 2018-10-01 14:58:23 +02:00
topics Fixed #29758 -- Documented how to test custom error views. 2018-10-01 18:16:47 -04:00
Makefile Fixed docs build with Sphinx 1.6. 2017-05-24 09:13:26 -04:00
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
conf.py Removed obsolete html_use_smartypants Sphinx option. 2018-09-18 11:51:04 -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 #28594 -- Removed Jython docs and specific code 2017-12-23 10:26:32 +01:00
make.bat
spelling_wordlist Fixed #28990 -- Added autosummarize parameter to BrinIndex. 2018-08-02 11:26:58 -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/