Autodoc __init__

meltano · Aug 11, 2022 · 594c2f3 · 594c2f3
1 parent 8e1fbde
commit 594c2f3
Show file tree

Hide file tree

Showing 32 changed files with 62 additions and 31 deletions.
diff --git a/docs/_templates/class.rst b/docs/_templates/class.rst
@@ -5,3 +5,4 @@
 
 .. autoclass:: {{ name }}
     :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.BatchSink.rst b/docs/classes/singer_sdk.BatchSink.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk
 
 .. autoclass:: BatchSink
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.GraphQLStream.rst b/docs/classes/singer_sdk.GraphQLStream.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk
 
 .. autoclass:: GraphQLStream
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.InlineMapper.rst b/docs/classes/singer_sdk.InlineMapper.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk
 
 .. autoclass:: InlineMapper
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.RESTStream.rst b/docs/classes/singer_sdk.RESTStream.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk
 
 .. autoclass:: RESTStream
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.RecordSink.rst b/docs/classes/singer_sdk.RecordSink.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk
 
 .. autoclass:: RecordSink
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.SQLConnector.rst b/docs/classes/singer_sdk.SQLConnector.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk
 
 .. autoclass:: SQLConnector
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.SQLSink.rst b/docs/classes/singer_sdk.SQLSink.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk
 
 .. autoclass:: SQLSink
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.SQLStream.rst b/docs/classes/singer_sdk.SQLStream.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk
 
 .. autoclass:: SQLStream
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.SQLTap.rst b/docs/classes/singer_sdk.SQLTap.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk
 
 .. autoclass:: SQLTap
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.SQLTarget.rst b/docs/classes/singer_sdk.SQLTarget.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk
 
 .. autoclass:: SQLTarget
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.Sink.rst b/docs/classes/singer_sdk.Sink.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk
 
 .. autoclass:: Sink
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.Stream.rst b/docs/classes/singer_sdk.Stream.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk
 
 .. autoclass:: Stream
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.Tap.rst b/docs/classes/singer_sdk.Tap.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk
 
 .. autoclass:: Tap
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.Target.rst b/docs/classes/singer_sdk.Target.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk
 
 .. autoclass:: Target
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.authenticators.APIKeyAuthenticator.rst b/docs/classes/singer_sdk.authenticators.APIKeyAuthenticator.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.authenticators
 
 .. autoclass:: APIKeyAuthenticator
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.authenticators.BasicAuthenticator.rst b/docs/classes/singer_sdk.authenticators.BasicAuthenticator.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.authenticators
 
 .. autoclass:: BasicAuthenticator
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.authenticators.BearerTokenAuthenticator.rst b/docs/classes/singer_sdk.authenticators.BearerTokenAuthenticator.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.authenticators
 
 .. autoclass:: BearerTokenAuthenticator
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.authenticators.OAuthAuthenticator.rst b/docs/classes/singer_sdk.authenticators.OAuthAuthenticator.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.authenticators
 
 .. autoclass:: OAuthAuthenticator
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.authenticators.OAuthJWTAuthenticator.rst b/docs/classes/singer_sdk.authenticators.OAuthJWTAuthenticator.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.authenticators
 
 .. autoclass:: OAuthJWTAuthenticator
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.authenticators.SimpleAuthenticator.rst b/docs/classes/singer_sdk.authenticators.SimpleAuthenticator.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.authenticators
 
 .. autoclass:: SimpleAuthenticator
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.exceptions.ConfigValidationError.rst b/docs/classes/singer_sdk.exceptions.ConfigValidationError.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.exceptions
 
 .. autoclass:: ConfigValidationError
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.exceptions.FatalAPIError.rst b/docs/classes/singer_sdk.exceptions.FatalAPIError.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.exceptions
 
 .. autoclass:: FatalAPIError
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.exceptions.InvalidStreamSortException.rst b/docs/classes/singer_sdk.exceptions.InvalidStreamSortException.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.exceptions
 
 .. autoclass:: InvalidStreamSortException
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.exceptions.MapExpressionError.rst b/docs/classes/singer_sdk.exceptions.MapExpressionError.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.exceptions
 
 .. autoclass:: MapExpressionError
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.exceptions.MaxRecordsLimitException.rst b/docs/classes/singer_sdk.exceptions.MaxRecordsLimitException.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.exceptions
 
 .. autoclass:: MaxRecordsLimitException
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.exceptions.RecordsWitoutSchemaException.rst b/docs/classes/singer_sdk.exceptions.RecordsWitoutSchemaException.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.exceptions
 
 .. autoclass:: RecordsWitoutSchemaException
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.exceptions.RetriableAPIError.rst b/docs/classes/singer_sdk.exceptions.RetriableAPIError.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.exceptions
 
 .. autoclass:: RetriableAPIError
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.exceptions.StreamMapConfigError.rst b/docs/classes/singer_sdk.exceptions.StreamMapConfigError.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.exceptions
 
 .. autoclass:: StreamMapConfigError
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.exceptions.TapStreamConnectionFailure.rst b/docs/classes/singer_sdk.exceptions.TapStreamConnectionFailure.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.exceptions
 
 .. autoclass:: TapStreamConnectionFailure
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.exceptions.TooManyRecordsException.rst b/docs/classes/singer_sdk.exceptions.TooManyRecordsException.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.exceptions
 
 .. autoclass:: TooManyRecordsException
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/conf.py b/docs/conf.py
@@ -52,7 +52,7 @@
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # Show typehints in the description, along with parameter descriptions
-autodoc_typehints = "description"
+autodoc_typehints = "signature"
 autodoc_class_signature = "separated"
 
 # -- Options for HTML output -------------------------------------------------
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,3 +5,4 @@

		.. autoclass:: {{ name }}
		:members:
		:special-members: __init__