fix: downgrade the autoapi and keep autoapi toctree to True by default (#453)

Co-authored-by: pyansys-ci-bot <[email protected]>

Author: Revathyvenugopal162

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
 - repo: https://github.com/psf/black
-  rev: 24.4.2
+  rev: 24.8.0
   hooks:
   - id: black
 
@@ -10,7 +10,7 @@ repos:
   - id: isort
 
 - repo: https://github.com/PyCQA/flake8
-  rev: 7.1.0
+  rev: 7.1.1
   hooks:
   - id: flake8
 
@@ -54,7 +54,7 @@ repos:
     exclude: 'src/ansys_sphinx_theme/theme/ansys_sphinx_theme/_templates/'
 
 - repo: https://github.com/ansys/pre-commit-hooks
-  rev: v0.3.1
+  rev: v0.4.3
   hooks:
   - id: add-license-headers
     files: '(src|doc/source/examples)/.*\.(py)'

doc/changelog.d/453.fixed.md

@@ -0,0 +1 @@
+fix: downgrade the autoapi and keep ``autoapi`` toctree to ``True`` by default

doc/source/conf.py

@@ -24,7 +24,6 @@
 
 THIS_PATH = Path(__file__).parent.resolve()
 EXAMPLE_PATH = (THIS_PATH / "examples" / "sphinx_examples").resolve()
-API_TEMPLATES = (THIS_PATH / "examples" / "autoapi").resolve()
 
 # Project information
 project = "ansys_sphinx_theme"
@@ -72,6 +71,7 @@
         "directory": "src/ansys_sphinx_theme/examples",
         "output": "examples/",
         "own_page_level": "function",
+        "add_toctree_entry": False,
     },
     "logo": "ansys",
 }

pyproject.toml

@@ -30,7 +30,7 @@ dependencies = [
 
 [project.optional-dependencies]
 autoapi = [
-    "sphinx-autoapi==3.2.1",
+    "sphinx-autoapi==3.1.1",
     "sphinx-design==0.6.1",
     "sphinx-jinja==2.0.2",
 ]

src/ansys_sphinx_theme/extension/autoapi.py

@@ -82,7 +82,7 @@ def prepare_jinja_env(jinja_env) -> None:
     app.config["autoapi_python_class_content"] = autoapi.get("class_content", "class")
     app.config["autoapi_options"] = autoapi.get("options", AUTOAPI_OPTIONS)
     app.config["autoapi_ignore"] = autoapi.get("ignore", [])
-    app.config["autoapi_add_toctree_entry"] = autoapi.get("add_toctree_entry", False)
+    app.config["autoapi_add_toctree_entry"] = autoapi.get("add_toctree_entry", True)
 
     # HACK: The ``autoapi_dirs`` should be given as a relative path to the conf.py.
     relative_autoapi_dir = os.path.relpath(