0
0
mirror of https://github.com/django/django.git synced 2024-11-29 22:56:46 +01:00
django/docs
2019-09-04 08:40:46 +02:00
..
_ext
_theme
faq Refs #29548 -- Updated docs for MariaDB support. 2019-05-27 19:59:49 +02:00
howto Refs #30736 -- Added missing versionadded annotations for Storage.get_alternative_name(). 2019-08-31 07:19:19 +02:00
internals Changed example git clone URLs to use HTTPS. 2019-09-04 08:11:22 +02:00
intro Changed example git clone URLs to use HTTPS. 2019-09-04 08:11:22 +02:00
man Updated man page for 2.2 final. 2019-04-01 12:04:08 +02:00
misc
ref Fixed #30738 -- Fixed typo in docs/ref/forms/widgets.txt. 2019-08-31 10:58:40 +02:00
releases Fixed #29714 -- Allowed using ExceptionReporter subclass with AdminEmailHandler. 2019-09-04 08:40:46 +02:00
topics Fixed #29714 -- Allowed using ExceptionReporter subclass with AdminEmailHandler. 2019-09-04 08:40:46 +02:00
conf.py Moved extlinks in docs config to allow using 'version' variable. 2019-03-28 20:47:51 -04:00
contents.txt
glossary.txt
index.txt Fixed #30451 -- Added ASGI handler and coroutine-safety. 2019-06-20 12:29:43 +02:00
make.bat
Makefile
README Fixed #30367 -- Changed "pip install" to "python -m pip install" in docs, comments and hints. 2019-04-18 14:41:15 +02:00
spelling_wordlist Fixed #30451 -- Added ASGI handler and coroutine-safety. 2019-06-20 12:29:43 +02:00

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 ``python -m 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/