django/docs
Mariusz Felisiak b41f669049 [4.0.x] Fixed crash building HTML docs since Sphinx 4.3.
See dd2ff3e911.
Backport of f0480ddd2d from main
2021-11-17 12:31:46 +01:00
..
_ext [4.0.x] Fixed crash building HTML docs since Sphinx 4.3. 2021-11-17 12:31:46 +01:00
_theme Fixed #32860 -- Made docs permalinks focusable to improve accessibility. 2021-06-21 13:47:26 +02:00
faq [4.0.x] Refs #32074 -- Doc'd Python 3.10 compatibility in Django 3.2.x. 2021-10-05 13:31:57 +02:00
howto [4.0.x] Used :source: role in docs/howto/custom-template-tags.txt. 2021-10-14 06:05:49 +02:00
internals [4.0.x] Refs #32956 -- Changed docs to treat the acronym HTTP phonetically. 2021-10-19 06:33:00 +02:00
intro [4.0.x] Corrected module reference in contributing tutorial. 2021-11-03 07:47:44 +01:00
man Updated man page for Django 4.0 alpha. 2021-09-20 20:55:10 +02:00
misc Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate. 2021-07-29 06:24:12 +02:00
ref [4.0.x] Fixed #33253 -- Reverted "Fixed #32319 -- Added ES module support to ManifestStaticFilesStorage." 2021-11-05 12:11:59 +01:00
releases [4.0.x] Fixed #33253 -- Reverted "Fixed #32319 -- Added ES module support to ManifestStaticFilesStorage." 2021-11-05 12:11:59 +01:00
topics [4.0.x] Fixed #33163 -- Added example of connection signal handlers in AppConfig.ready() to docs. 2021-11-17 12:30:19 +01: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 [4.0.x] Bumped django_next_version in docs config. 2021-09-20 21:00:55 +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 32956 -- Lowercased spelling of "web" and "web framework" where appropriate. 2021-07-29 06:24:12 +02:00
make.bat Added spelling option to make.bat. 2021-04-30 14:04:22 +02:00
requirements.txt [4.0.x] Refs #33247 -- Corrected configuration for Read The Docs. 2021-11-03 18:46:08 +01:00
spelling_wordlist [4.0.x] Added 'formatter' to spelling wordlist. 2021-10-12 15:16: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/