django/docs
Mariusz Felisiak 8a5683b6b2 Added stub release notes for 2.2.16 and 3.0.10. 2020-08-11 10:31:44 +02:00
..
_ext
_theme Fixed #16300 -- Improved singlehtml docs formatting with headers CSS. 2020-06-22 21:05:13 +02:00
faq Removed reference to unsupported versions of Django and Python. 2020-06-03 21:28:14 +02:00
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 Updated How to install Django on Windows guide. 2020-06-03 16:28:10 +02:00
man
misc
ref Removed unnecessary sentence in QuerySet docs. 2020-08-07 08:05:47 +02:00
releases Added stub release notes for 2.2.16 and 3.0.10. 2020-08-11 10:31:44 +02:00
topics Added note about password updates on argon2 attributes change. 2020-08-11 07:51:27 +02:00
Makefile
README.rst
conf.py
contents.txt
glossary.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
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/