docs: Document inherited PluginBase attributes and methods (#1243)

meltano · Dec 6, 2022 · faed940 · faed940
1 parent c94ae17
commit faed940
Show file tree

Hide file tree

Showing 8 changed files with 24 additions and 2 deletions.
diff --git a/docs/_templates/plugin_class.rst 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
@@ -5,4 +5,6 @@
 
 .. autoclass:: InlineMapper
     :members:
+    :show-inheritance:
+    :inherited-members:
     :special-members: __init__
diff --git 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__
diff --git 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__
diff --git 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__
diff --git 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__
diff --git 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
@@ -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}")