Browse Source

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.
Mariusz Felisiak 2 years ago
parent
commit
279967ec85
1 changed files with 4 additions and 0 deletions
  1. 4 0
      docs/conf.py

+ 4 - 0
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"