django/docs
Adam Alton 6e9c5ee88f
Removed unnecessary sentence in QuerySet docs.
2020-08-07 08:05:47 +02:00
..
_ext
_theme
faq
howto Added Hypercorn to ASGI deployment guide. 2020-08-05 12:14:06 +02:00
internals Fixed #31842 -- Added DEFAULT_HASHING_ALGORITHM transitional setting. 2020-08-04 09:35:24 +02:00
intro
man
misc
ref Removed unnecessary sentence in QuerySet docs. 2020-08-07 08:05:47 +02:00
releases Fixed #25513 -- Extracted admin pagination to Paginator.get_elided_page_range(). 2020-08-06 12:38:56 +02:00
topics Fixed #31842 -- Added DEFAULT_HASHING_ALGORITHM transitional setting. 2020-08-04 09:35:24 +02:00
Makefile
README.rst
conf.py
contents.txt
glossary.txt
index.txt
make.bat
spelling_wordlist Added Hypercorn to ASGI deployment guide. 2020-08-05 12:14:06 +02:00

README.rst

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/