1
0
mirror of https://github.com/django/django.git synced 2024-12-23 01:25:58 +00:00
django/docs
Hasan Ramezani f5669fd7b5 Fixed #32899 -- Added note about avoiding non-dict objects in JsonResponse docs.
Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
2021-07-13 10:25:03 +02:00
..
_ext
_theme Fixed #32860 -- Made docs permalinks focusable to improve accessibility. 2021-06-21 13:47:26 +02:00
faq Refs #31356 -- Changed IRC links to the Libera.Chat webchat. 2021-06-03 12:07:30 +02:00
howto Refs #32880 -- Made some titles consistent in how-to documents. 2021-07-13 09:25:37 +02:00
internals Fixed #24522 -- Added a --shuffle option to DiscoverRunner. 2021-07-08 07:29:04 +02:00
intro Refs #32338 -- Improved accessibility of RadioSelect examples in docs. 2021-06-04 08:28:25 +02:00
man
misc
ref Fixed #32899 -- Added note about avoiding non-dict objects in JsonResponse docs. 2021-07-13 10:25:03 +02:00
releases Fixed #27021 -- Allowed lookup expressions in annotations, aggregations, and QuerySet.filter(). 2021-07-09 11:43:06 +02:00
topics Refs #32880 -- Created a new logging how-to document. 2021-07-12 09:04:25 +02:00
conf.py Refs #31356 -- Changed IRC links to the Libera.Chat webchat. 2021-06-03 12:07:30 +02:00
contents.txt
glossary.txt
index.txt
make.bat Added spelling option to make.bat. 2021-04-30 14:04:22 +02:00
Makefile
README.rst
requirements.txt
spelling_wordlist Changed IRC references to Libera.Chat. 2021-05-20 12:23:36 +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), and the `Sphinx`_ documentation system.
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.

.. _ReST: https://docutils.sourceforge.io/rst.html
.. _Sphinx: https://www.sphinx-doc.org/