0
0
mirror of https://github.com/django/django.git synced 2024-11-25 16:09:27 +01:00
django/docs
2019-12-16 14:59:59 +01:00
..
_ext Fixed #31025 -- Fixed highlightlinenothreshold deprecation warning on Sphinx 1.8+. 2019-11-25 10:33:33 +01:00
_theme Fixed #31080 -- Removed redundant type="text/javascript" attribute from <script> tags. 2019-12-11 09:49:54 +01:00
faq Fixed #23433 -- Deprecated django-admin.py entry point in favor of django-admin. 2019-12-06 12:11:44 +01:00
howto Refs #20935 -- Removed duplicate ToC references. 2019-12-04 11:36:40 +01:00
internals Fixed #23433 -- Deprecated django-admin.py entry point in favor of django-admin. 2019-12-06 12:11:44 +01:00
intro Fixed #31062 -- Doc'd asgi.py in tutorials and project templates. 2019-12-05 08:38:39 +01:00
man
misc
ref Fixed #31088 -- Added support for websearch searching in SearchQuery. 2019-12-16 14:59:59 +01:00
releases Fixed #31088 -- Added support for websearch searching in SearchQuery. 2019-12-16 14:59:59 +01:00
topics Fixed #31069, Refs #26431 -- Doc'd RegexPattern behavior change in passing optional named groups in Django 3.0. 2019-12-12 14:24:10 +01:00
conf.py
contents.txt
glossary.txt
index.txt Refs #30451 -- Doc'd asynchronous support and async-safety. 2019-12-03 17:29:10 +01:00
make.bat
Makefile
README
spelling_wordlist Fixed #31056 -- Allowed disabling async-unsafe check with an environment variable. 2019-12-03 17:29:31 +01: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/