django/docs
Jon Dufresne dd5173ca1b Fixed #31892 -- Added backward incompatibility note about Media <script> tags changes.
Refs 31080.
2020-08-17 10:13:18 +02:00
..
_ext Made default_role_error use logger. 2020-06-03 11:42:42 +02:00
_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 Updated man page for Django 3.1 alpha. 2020-05-12 11:26:37 +02:00
misc Expanded API stability docs to include our policy of continual improvement. 2019-11-18 20:37:46 +01:00
ref Refs #31811 -- Added optional timing outputs to the test runner. 2020-08-13 17:17:15 +02:00
releases Fixed #31892 -- Added backward incompatibility note about Media <script> tags changes. 2020-08-17 10:13:18 +02:00
topics Refs #31811 -- Added optional timing outputs to the test runner. 2020-08-13 17:17:15 +02:00
Makefile Fixed docs build with Sphinx 1.6. 2017-05-24 09:13:26 -04:00
README.rst Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 2020-01-29 06:04:15 +01:00
conf.py Bumped version; master is now 3.2 pre-alpha. 2020-05-13 09:07:51 +02:00
contents.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
glossary.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
index.txt Fixed #25712 -- Reorganized templates docs. 2020-04-30 08:12:09 +02:00
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/