diff --git a/docs/source/conf.py b/docs/source/conf.py index 329a95dd76cd94377903a5b1e2f40d3ad2076455..3f4d36bd86b823b9fe642011cd62c8efa55ee16a 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 9cac78e330bb4b69cce5b1dd546c9d8fb8167170..76b4b40c4795fa870bdefc65e758f0476f747d5a 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 7e902e9456ca07f8aa54fb862df81dc3e51f9164..0082f9bf2525d3ba32f19a6e3918cbe32348b2de 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 = {