FEAT: Added autoapi integration

.gitignore

@@ -357,6 +357,7 @@ venv.bak/
 # sphinx build
 doc/_build/
 doc/source/examples
+doc/source/api_full
 doc/build_errors.txt
 _autosummary/
 

doc/Makefile

@@ -10,6 +10,9 @@ BUILDDIR      = _build
 LINKCHECKDIR  = $(BUILDDIR)/linkcheck
 LINKCHECKOPTS = -d $(BUILDDIR)/.doctrees -W --keep-going --color
 
+# Skip building the cheat sheet
+SKIP_BUILD_CHEAT_SHEET = False
+
 # Put it first so that "make" without argument is like "make help".
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

doc/changelog.d/6800.added.md

@@ -0,0 +1 @@
+Added autoapi integration

doc/make.bat

@@ -15,6 +15,9 @@ set BUILDDIR=_build
 set LINKCHECKDIR=\%BUILDDIR%\linkcheck
 set LINKCHECKOPTS=-d %BUILDDIR%\.doctrees -W --keep-going --color
 
+::Skip building the cheat sheet
+set SKIP_BUILD_CHEAT_SHEET=False
+
 REM This LOCs are used to uninstall and install specific package(s) during CI/CD
 for /f %%i in ('pip freeze ^| findstr /c:"vtk-osmesa"') do set is_vtk_osmesa_installed=%%i
 if NOT "%is_vtk_osmesa_installed%" == "vtk-osmesa" if "%ON_CI%" == "True" (

doc/source/API/index.rst

@@ -15,6 +15,10 @@ and Mechanical solvers for comprehensive multiphysics analysis.
 Tight integration among these solutions provides unprecedented ease of use for setup and
 faster resolution of complex simulations for design and optimization.
 
+.. note::
+  For the complete API reference and additional documentation, please visit:
+  :doc:`../api_full/ansys/aedt/core/index`
+
 .. image:: ../Resources/aedt_2.png
   :width: 800
   :alt: AEDT Applications

doc/source/conf.py

@@ -151,6 +151,7 @@ def setup(app):
     "sphinx.ext.todo",
     "sphinx_copybutton",
     "sphinx_design",
+    "ansys_sphinx_theme.extension.autoapi",
 ]
 
 # Intersphinx mapping
@@ -303,8 +304,17 @@ def setup(app):
         "file": "cheatsheet/cheat_sheet.qmd",
         "title": "PyAEDT cheat sheet",
     },
+    "ansys_sphinx_theme_autoapi": {
+        "project": "PyAEDT",
+        "output": "api_full"
+    }
 }
 
+
+# Determine whether to skip cheat sheet build or not
+if os.environ.get("SKIP_BUILD_CHEAT_SHEET"):
+    html_theme_options.pop("cheatsheet")
+
 # # Add button to download PDF
 # html_theme_options["icon_links"].append(
 #     {

pyproject.toml

@@ -76,7 +76,7 @@ dotnet = [
     "pywin32>=303; platform_system=='Windows'",
 ]
 doc = [
-    "ansys-sphinx-theme>=1.0.0,<1.7",
+    "ansys-sphinx-theme[autoapi]>=1.0.0,<1.7",
     "jupyter",
     "numpydoc>=1.5.0,<1.9",
     "recommonmark",