django/docs
Mariusz Felisiak 350123f38c
Moved release note for refs #30158 from deprecated to backwards incompatible changes.
2019-09-05 15:56:52 +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 Fixed typo in docs/internals/contributing/writing-documentation.txt. 2019-09-05 14:06:46 +02:00
intro Changed example git clone URLs to use HTTPS. 2019-09-04 08:11:22 +02:00
man
misc
ref Fixed #27910 -- Added enumeration helpers for use in Field.choices. 2019-09-04 14:42:49 +02:00
releases Moved release note for refs #30158 from deprecated to backwards incompatible changes. 2019-09-05 15:56:52 +02:00
topics Fixed #27910 -- Added enumeration helpers for use in Field.choices. 2019-09-04 14:42:49 +02:00
Makefile
README
conf.py
contents.txt
glossary.txt
index.txt Fixed #30451 -- Added ASGI handler and coroutine-safety. 2019-06-20 12:29:43 +02:00
make.bat
spelling_wordlist Fixed #27910 -- Added enumeration helpers for use in Field.choices. 2019-09-04 14:42:49 +02: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 ``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/