From faed940b931164e632d802b73db0ee75e0bfb77c Mon Sep 17 00:00:00 2001 From: "Edgar R. M" Date: Tue, 6 Dec 2022 17:08:34 -0600 Subject: [PATCH] docs: Document inherited `PluginBase` attributes and methods (#1243) --- docs/_templates/plugin_class.rst | 10 ++++++++++ docs/classes/singer_sdk.InlineMapper.rst | 2 ++ docs/classes/singer_sdk.SQLTap.rst | 2 ++ docs/classes/singer_sdk.SQLTarget.rst | 2 ++ docs/classes/singer_sdk.Tap.rst | 2 ++ docs/classes/singer_sdk.Target.rst | 2 ++ docs/reference.rst | 2 +- singer_sdk/plugin_base.py | 4 +++- 8 files changed, 24 insertions(+), 2 deletions(-) create mode 100644 docs/_templates/plugin_class.rst diff --git a/docs/_templates/plugin_class.rst b/docs/_templates/plugin_class.rst new file mode 100644 index 000000000..f0f50324a --- /dev/null +++ b/docs/_templates/plugin_class.rst @@ -0,0 +1,10 @@ +{{ fullname }} +{{ "=" * fullname|length }} + +.. currentmodule:: {{ module }} + +.. autoclass:: {{ name }} + :members: + :show-inheritance: + :inherited-members: + :special-members: __init__ diff --git a/docs/classes/singer_sdk.InlineMapper.rst b/docs/classes/singer_sdk.InlineMapper.rst index 978ef7fbb..a6e8b5e7b 100644 --- a/docs/classes/singer_sdk.InlineMapper.rst +++ b/docs/classes/singer_sdk.InlineMapper.rst @@ -5,4 +5,6 @@ .. autoclass:: InlineMapper :members: + :show-inheritance: + :inherited-members: :special-members: __init__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.SQLTap.rst b/docs/classes/singer_sdk.SQLTap.rst index 1c49d105a..84433750f 100644 --- a/docs/classes/singer_sdk.SQLTap.rst +++ b/docs/classes/singer_sdk.SQLTap.rst @@ -5,4 +5,6 @@ .. autoclass:: SQLTap :members: + :show-inheritance: + :inherited-members: :special-members: __init__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.SQLTarget.rst b/docs/classes/singer_sdk.SQLTarget.rst index 36c32244f..5c16f3f3f 100644 --- a/docs/classes/singer_sdk.SQLTarget.rst +++ b/docs/classes/singer_sdk.SQLTarget.rst @@ -5,4 +5,6 @@ .. autoclass:: SQLTarget :members: + :show-inheritance: + :inherited-members: :special-members: __init__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.Tap.rst b/docs/classes/singer_sdk.Tap.rst index ae4cb051b..cd6702fb5 100644 --- a/docs/classes/singer_sdk.Tap.rst +++ b/docs/classes/singer_sdk.Tap.rst @@ -5,4 +5,6 @@ .. autoclass:: Tap :members: + :show-inheritance: + :inherited-members: :special-members: __init__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.Target.rst b/docs/classes/singer_sdk.Target.rst index c6aabb5af..153479355 100644 --- a/docs/classes/singer_sdk.Target.rst +++ b/docs/classes/singer_sdk.Target.rst @@ -5,4 +5,6 @@ .. autoclass:: Target :members: + :show-inheritance: + :inherited-members: :special-members: __init__ \ No newline at end of file diff --git a/docs/reference.rst b/docs/reference.rst index ec89e5ec8..53cdd9e0a 100644 --- a/docs/reference.rst +++ b/docs/reference.rst @@ -8,7 +8,7 @@ Plugin Classes .. autosummary:: :toctree: classes - :template: class.rst + :template: plugin_class.rst Tap Target diff --git a/singer_sdk/plugin_base.py b/singer_sdk/plugin_base.py index 561e4c5c3..feb0f0db3 100644 --- a/singer_sdk/plugin_base.py +++ b/singer_sdk/plugin_base.py @@ -275,7 +275,9 @@ def print_version( Args: print_fn: A function to use to display the plugin version. - Defaults to :function:`print`. + Defaults to `print`_. + + .. _print: https://docs.python.org/3/library/functions.html#print """ print_fn(f"{cls.name} v{cls.plugin_version}, Meltano SDK v{cls.sdk_version}")