Let Sphinx handle adding domain directives to the toctree (#374)

* Remove ability to add domains to the toctree * Add towncrier news fragment
readthedocs · Mar 28, 2023 · 6b16e02 · 6b16e02
1 parent 007d995
commit 6b16e02
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 171 deletions.
diff --git a/autoapi/extension.py b/autoapi/extension.py
@@ -26,7 +26,6 @@
 from .directives import AutoapiSummary, NestedParse
 from .inheritance_diagrams import AutoapiInheritanceDiagram
 from .settings import API_ROOT
-from .toctree import add_domain_to_toctree
 
 LOGGER = sphinx.util.logging.getLogger(__name__)
 
@@ -183,9 +182,6 @@ def doctree_read(app, doctree):
     Inject AutoAPI into the TOC Tree dynamically.
     """
 
-    if app.config.autoapi_add_objects_to_toctree:
-        add_domain_to_toctree(app, doctree, app.env.docname)
-
     if app.env.docname == "index":
         all_docs = set()
         insert = True
@@ -296,7 +292,6 @@ def setup(app):
     app.add_config_value("autoapi_python_class_content", "class", "html")
     app.add_config_value("autoapi_generate_api_docs", True, "html")
     app.add_config_value("autoapi_prepare_jinja_env", None, "html")
-    app.add_config_value("autoapi_add_objects_to_toctree", True, "html")
     app.add_autodocumenter(documenters.AutoapiFunctionDocumenter)
     app.add_autodocumenter(documenters.AutoapiPropertyDocumenter)
     app.add_autodocumenter(documenters.AutoapiDecoratorDocumenter)

diff --git a/autoapi/toctree.py b/autoapi/toctree.py
diff --git a/docs/changes/+toctree.removal.rst b/docs/changes/+toctree.removal.rst
@@ -0,0 +1,2 @@
+Removed the option to have autoapi generate toctree entries for domain objects.
+Dropped support for sphinx < 5.2.0.
diff --git a/setup.cfg b/setup.cfg
@@ -37,7 +37,7 @@ install_requires =
     astroid>=2.7
     Jinja2
     PyYAML
-    sphinx>=4.0
+    sphinx>=5.2.0
     unidecode
 
 [options.extras_require]

diff --git a/tests/test_integration.py b/tests/test_integration.py
@@ -116,7 +116,9 @@ def test_toctree_domain_insertion(self):
         """
         Test that the example_function gets added to the TOC Tree
         """
-        self._run_test("toctreeexample", "_build/text/index.txt", "* example_function")
+        self._run_test(
+            "toctreeexample", "_build/text/index.txt", '* "example_function()"'
+        )
 
 
 class TestExtensionErrors:
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		Removed the option to have autoapi generate toctree entries for domain objects.
		Dropped support for sphinx < 5.2.0.