1
0
mirror of https://github.com/django/django.git synced 2024-12-23 17:46:27 +00:00
django/docs
2019-08-19 11:43:06 +02:00
..
_ext
_theme
faq Refs #29548 -- Updated docs for MariaDB support. 2019-05-27 19:59:49 +02:00
howto Fixed #30694 -- Documented FileResponse does not seek its file source. 2019-08-17 09:20:36 +02:00
internals Fixed #30451 -- Added ASGI handler and coroutine-safety. 2019-06-20 12:29:43 +02:00
intro Fixed broken links to Dive Into Python 3 book. 2019-08-19 07:03:43 +02:00
man
misc
ref Fixed broken links and redirects to OGR library in docs. 2019-08-19 11:43:06 +02:00
releases Refs #28428 -- Made FileField.upload_to support pathlib.Path. 2019-08-18 20:34:58 +02:00
topics Fixed #30661 -- Added models.SmallAutoField. 2019-08-02 11:39:01 +02:00
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
Makefile
README
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/