django/docs
Timothy McCurrach 4659a790cf Fixed #32860 -- Made docs permalinks focusable to improve accessibility. 2021-06-21 13:47:26 +02:00
..
_ext Made default_role_error use logger. 2020-06-03 11:42:42 +02:00
_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 #32720 -- Updated various links in docs to avoid redirects and use HTTPS. 2021-05-17 09:46:09 +02:00
internals Refs #31356 -- Changed IRC links to the Libera.Chat webchat. 2021-06-03 12:07:30 +02:00
intro Refs #32338 -- Improved accessibility of RadioSelect examples in docs. 2021-06-04 08:28:25 +02:00
man Updated django-admin man page for Django 3.2. 2021-01-14 14:58:28 +01:00
misc Expanded API stability docs to include our policy of continual improvement. 2019-11-18 20:37:46 +01:00
ref Fixed #32195 -- Added system check for invalid view in path() and improved error messages. 2021-06-09 09:06:42 +02:00
releases Fixed #32824 -- Improved performance of NodeList.render(). 2021-06-11 12:22:06 +02:00
topics Fixed #30427, Fixed #16176 -- Corrected setting descriptor in Field.contribute_to_class(). 2021-06-15 12:01:28 +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 Refs #31356 -- Changed IRC links to the Libera.Chat webchat. 2021-06-03 12:07:30 +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 Added spelling option to make.bat. 2021-04-30 14:04:22 +02:00
requirements.txt Used GitHub actions for docs tests. 2021-02-26 22:12:25 +01:00
spelling_wordlist Changed IRC references to Libera.Chat. 2021-05-20 12:23:36 +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/