Change: Use sphinx directly for typehints in API docs

Drop using the external plugin for typehints. This isn't necessary anymore because sphinx comes with support for typehints nowadays.
greenbone · Aug 11, 2022 · f707efd · f707efd
1 parent 4a0f170
commit f707efd
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 29 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -47,7 +47,6 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.githubpages",
     "sphinx.ext.napoleon",
-    "sphinx_autodoc_typehints",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -123,6 +122,11 @@
 
 html_show_sourcelink = False
 
+autodoc_typehints = "description"
+autodoc_typehints_description_target = "documented"
+
+autodoc_class_signature = "separated"
+
 
 # -- Options for HTMLHelp output ---------------------------------------------
 

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -41,7 +41,6 @@ defusedxml = ">=0.6,<0.8"
 coverage = "^6.4"
 pylint = "^2.13"
 sphinx = "^5.1.1"
-sphinx-autodoc-typehints = "^1.19.1"
 autohooks = ">=22.7.2"
 autohooks-plugin-pylint = ">=21.6.0"
 autohooks-plugin-black = ">=22.7.0"