Use sphinx-autoapi over sphinx-autodoc

Yubico · Nov 8, 2024 · af86978 · af86978
1 parent 03efb60
commit af86978
Show file tree

Hide file tree

Showing 8 changed files with 8 additions and 272 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -47,13 +47,15 @@ def get_version():
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    "sphinx.ext.autodoc",
-    "sphinx_autodoc_typehints",
+    "autoapi.extension",
+    "sphinx.ext.autodoc.typehints",
     "sphinx.ext.doctest",
     "sphinx.ext.intersphinx",
     "sphinx.ext.viewcode",
 ]
 
+autodoc_typehints = "description"
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
@@ -191,3 +193,4 @@ def get_version():
 
 # Custom config
 autodoc_member_order = "bysource"
+autoapi_dirs = ["../fido2"]
diff --git a/docs/index.rst b/docs/index.rst
@@ -10,7 +10,8 @@ Welcome to python-fido2's documentation!
    :maxdepth: 2
    :caption: Contents:
 
-   rst/packages
+   autoapi/index
+
 
 Indices and tables
 ==================

diff --git a/docs/rst/fido2.attestation.rst b/docs/rst/fido2.attestation.rst
diff --git a/docs/rst/fido2.ctap2.rst b/docs/rst/fido2.ctap2.rst
diff --git a/docs/rst/fido2.hid.rst b/docs/rst/fido2.hid.rst
diff --git a/docs/rst/fido2.rst b/docs/rst/fido2.rst
diff --git a/docs/rst/packages.rst b/docs/rst/packages.rst
diff --git a/pyproject.toml b/pyproject.toml
@@ -42,7 +42,7 @@ pcsc = ["pyscard"]
 pytest = "^7.0"
 Sphinx = {version = "^8.1", python = ">=3.10"}
 sphinx-rtd-theme = {version = "^3.0.1", python = ">=3.10"}
-sphinx-autodoc-typehints = {version = "^2.5.0", python = ">=3.10"}
+sphinx-autoapi = (version = "^3.3.3", python = ">=3.10"}
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]