FEAT: Updates docs with autoapi (#252)

Author: dipinknair

.github/workflows/ci_cd.yml

@@ -40,7 +40,6 @@ jobs:
         uses: ansys/actions/build-wheelhouse@v8
         with:
           library-name: ${{ env.PACKAGE_NAME }}
-          library-namespace: ${{ env.PACKAGE_NAMESPACE }}
           operating-system: ${{ matrix.os }}
           python-version: ${{ matrix.python-version }}
 
@@ -139,7 +138,6 @@ jobs:
           token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }}
           bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
           bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}
-          python-version: ${{ env.MAIN_PYTHON_VERSION }}
 
   upload_docs_release:
     name: Upload release documentation
@@ -154,4 +152,3 @@ jobs:
           token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }}
           bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
           bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}
-          python-version: ${{ env.MAIN_PYTHON_VERSION }}

.gitignore

@@ -48,6 +48,7 @@ test-output.xml
 
 .venv
 /env
+.env
 .DS_Store
 doc/_build/*/*
-
+doc/source/api/*

CHANGELOG.md

@@ -16,6 +16,11 @@ Further information about contributing to ansys-tools-path can be found in
 
 [PyAnsys Developer's Guide]: https://dev.docs.pyansys.com/
 
+## [Unreleased]()
+
+### What's Changed
+Update docs with autoapi [#252](https://github.com/ansys/ansys-tools-path/pull/252)
+
 ## [v0.7.0]() - 13 November 2024
 
 ### What's Changed

doc/source/api.rst

@@ -40,10 +40,15 @@
     "additional_breadcrumbs": [
         ("PyAnsys", "https://docs.pyansys.com/"),
     ],
+    "ansys_sphinx_theme_autoapi": {
+        "project": project,
+        "directory": "src/ansys",
+    },
 }
 
 # Sphinx extensions
 extensions = [
+    "ansys_sphinx_theme.extension.autoapi",
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
     "numpydoc",
@@ -73,7 +78,7 @@
 numpydoc_validation_checks = {
     "GL06",  # Found unknown section
     "GL07",  # Sections are in the wrong order.
-    "GL08",  # The object does not have a docstring
+    # "GL08",  # The object does not have a docstring
     "GL09",  # Deprecation warning should precede extended summary
     "GL10",  # reST directives {directives} must be followed by two colons
     "SS01",  # No summary found

doc/source/conf.py

@@ -8,7 +8,7 @@
    :hidden:
    :maxdepth: 3
 
-   api
+   api/index
    contribute
 
 
@@ -27,7 +27,7 @@ How to install
 How to use
 ----------
 
-You can use any of the functions available in the :ref:`ref_api`
+You can use any of the functions available in the
 to identify the path of the local Ansys installation.
 
 For example you can use :func:`find_ansys <ansys.tools.path.find_ansys>`

doc/source/index.rst

@@ -32,7 +32,7 @@ tests = ["pytest==8.3.3", "pytest-cov==6.0.0", "pyfakefs==5.7.1"]
 
 doc = [
     "Sphinx==8.1.3",
-    "ansys-sphinx-theme==1.2.2",
+    "ansys-sphinx-theme[autoapi]==1.2.2",
     "numpydoc==1.8.0",
     "sphinx-copybutton==0.5.2",
 ]

pyproject.toml

@@ -41,8 +41,8 @@
 PRODUCT_TYPE = Literal["mapdl", "mechanical", "dyna"]
 SUPPORTED_VERSIONS_TYPE = Dict[int, str]
 
-LINUX_DEFAULT_DIRS = [["/", "usr", "ansys_inc"], ["/", "ansys_inc"], ["/", "install", "ansys_inc"]]
-LINUX_DEFAULT_DIRS = [os.path.join(*each) for each in LINUX_DEFAULT_DIRS]
+linux_default_dirs = [["/", "usr", "ansys_inc"], ["/", "ansys_inc"], ["/", "install", "ansys_inc"]]
+LINUX_DEFAULT_DIRS = [os.path.join(*each) for each in linux_default_dirs]
 
 CONFIG_FILE_NAME = "config.txt"