Skip to content
Snippets Groups Projects
Commit e515a743 authored by Karel van Klink's avatar Karel van Klink :smiley_cat:
Browse files

hide implicit type hints when generating autodoc

parent 917dc095
Branches
Tags
1 merge request!80Feature/update documentation
......@@ -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
......
......@@ -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.
......
......@@ -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 = {
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment