From e515a743d22ade834f8460e5d290986d5aae3226 Mon Sep 17 00:00:00 2001
From: Karel van Klink <karel.vanklink@geant.org>
Date: Thu, 5 Oct 2023 15:34:29 +0200
Subject: [PATCH] hide implicit type hints when generating autodoc
---
docs/source/conf.py | 1 +
docs/vale/.vale.ini | 2 +-
gso/services/infoblox.py | 4 ++--
3 files changed, 4 insertions(+), 3 deletions(-)
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 329a95dd..3f4d36bd 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -21,6 +21,7 @@ html_logo = 'static/geant_logo_white.svg'
# Both the class' and the ``__init__`` method's docstring are concatenated and inserted.
autoclass_content = 'both'
+autodoc_typehints = 'none'
# Display todos by setting to True
todo_include_todos = True
diff --git a/docs/vale/.vale.ini b/docs/vale/.vale.ini
index 9cac78e3..76b4b40c 100644
--- a/docs/vale/.vale.ini
+++ b/docs/vale/.vale.ini
@@ -26,7 +26,7 @@ custom.Contractions = YES
Microsoft.Negative = NO
Microsoft.RangeFormat = NO
-TokenIgnores = (:term:`\S+`), (:param \S+(?: \S+)?:), (:type \S+:), (:return \S+:), (:rtype: \S+)
+TokenIgnores = (:term:`\S+`), (:param \S+(?: \S+)?:), (:type \S+:), (:return \S+:), (:rtype: \S+), (:class:`\S+`)
[*/glossary.rst]
; Ignore acronyms being undefined in the file that defines all acronyms by definition.
diff --git a/gso/services/infoblox.py b/gso/services/infoblox.py
index 7e902e94..0082f9bf 100644
--- a/gso/services/infoblox.py
+++ b/gso/services/infoblox.py
@@ -20,8 +20,8 @@ class DeletionError(Exception):
def _setup_connection() -> tuple[connector.Connector, IPAMParams]:
"""Set up a new connection with an Infoblox instance.
- :return: A tuple that has an Infoblox `Connector` instance, and :term:`IPAM` parameters.
- :rtype: tuple[:class:`infoblox_client.connector.Connector`, IPAMParams]
+ :return: A tuple that has an Infoblox ``Connector`` instance, and :term:`IPAM` parameters.
+ :rtype: tuple[:class:`Connector`, IPAMParams]
"""
oss = load_oss_params().IPAM
options = {
--
GitLab