summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMariusz Felisiak <felisiak.mariusz@gmail.com>2022-12-29 06:07:51 +0100
committerMariusz Felisiak <felisiak.mariusz@gmail.com>2022-12-29 06:15:37 +0100
commitb381ab4906cdff0ebb4e1c6c8e30996f24be6829 (patch)
tree83ddf8750fa04fde2f7b948e1ed50d8e16c8349e
parentf6f0699d01f5840437bfd236c76c797943ef8edc (diff)
[3.2.x] Disabled auto-created table of contents entries on Sphinx 5.2+.
Auto-created table of contents entries for all domain objects (e.g. functions, classes, attributes, etc.) were added in Sphinx 5.2, see https://github.com/sphinx-doc/sphinx/issues/6316. An option to control new table of contents entries was added in Sphinx 5.2.3, see https://github.com/sphinx-doc/sphinx/pull/10886. Backport of 279967ec859a9a5240318cf29a077539b0e3139f from main
-rw-r--r--docs/conf.py4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py
index fabe91cc38..42d350052c 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -73,6 +73,10 @@ source_suffix = '.txt'
# The root toctree document.
root_doc = "contents"
+# Disable auto-created table of contents entries for all domain objects (e.g.
+# functions, classes, attributes, etc.) in Sphinx 5.2+.
+toc_object_entries = False
+
# General substitutions.
project = 'Django'
copyright = 'Django Software Foundation and contributors'