maint: Update conf.py

.gitignore

@@ -34,6 +34,7 @@ dist/
 _autosummary
 _build/
 _gallery_backreferences
+doc/source/api
 
 # Testing
 .coverage

doc/changelog.d/937.documentation.md

@@ -0,0 +1 @@
+maint: Update conf.py

doc/source/conf.py

@@ -58,6 +58,12 @@
             "icon": "fa fa-comment fa-fw",
         },
     ],
+    "ansys_sphinx_theme_autoapi": {
+        "project": project,
+        "keep_files": True,
+        "add_toctree_entry": True,
+        "package_depth": 5,
+    },
     "cheatsheet": {
         "file": "cheatsheet/cheat_sheet.qmd",
         "title": "PyPrimeMesh cheat sheet",
@@ -67,7 +73,6 @@
 
 # Sphinx extensions
 extensions = [
-    'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
     "numpydoc",
     "sphinx.ext.intersphinx",
@@ -79,10 +84,10 @@
     "sphinx.ext.coverage",
     "sphinx.ext.doctest",
     "sphinx.ext.extlinks",
-    "sphinx_autodoc_typehints",
     "sphinxemoji.sphinxemoji",
     "sphinx_design",
     "pyvista.ext.viewer_directive",
+    "ansys_sphinx_theme.extension.autoapi",
 ]
 nbsphinx_execute = "always"
 
@@ -179,3 +184,42 @@
 }
 
 supress_warnings = ["docutils"]
+
+
+exclude_patterns = [
+    "examples/**/*.ipynb",
+    "examples/**/*.py",
+    "examples/**/*.md5",
+    "api/ansys/visualizer/index.rst",
+]
+
+
+BUILD_API = True
+if not BUILD_API:
+    exclude_patterns.append("autoapi")
+
+BUILD_EXAMPLES = True
+if not BUILD_EXAMPLES:
+    exclude_patterns.append("examples/**")
+    exclude_patterns.append("examples.rst")
+
+jinja_contexts = {
+    "main_toctree": {
+        "build_api": BUILD_API,
+        "build_examples": BUILD_EXAMPLES,
+    }
+}
+
+
+def prepare_jinja_env(jinja_env) -> None:
+    """Customize the jinja env.
+
+    Notes
+    -----
+    See https://jinja.palletsprojects.com/en/3.0.x/api/#jinja2.Environment
+
+    """
+    jinja_env.globals["project_name"] = project
+
+
+autoapi_prepare_jinja_env = prepare_jinja_env