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:06 +0100
commit0a8b4301d231b1b69db895fd80fe3a1054d2a1cc (patch)
treeb62d040ca09e8e0bc6d5961ee5bd9ce88bed2f1f
parent24aad2d12823b07be877e36be29a40b46e7f173e (diff)
[4.0.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 89e9637cf3..a0f565b3af 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -97,6 +97,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"