From e17a0eaab5c5a145697c1f6238a09cd36363c3d9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edgar=20Ram=C3=ADrez=20Mondrag=C3=B3n?= Date: Tue, 29 Oct 2024 20:04:00 -0600 Subject: [PATCH] docs: Generate API reference docs --- docs/classes/singer_sdk.BatchSink.rst | 8 - docs/classes/singer_sdk.GraphQLStream.rst | 8 - docs/classes/singer_sdk.InlineMapper.rst | 10 -- docs/classes/singer_sdk.RESTStream.rst | 8 - docs/classes/singer_sdk.RecordSink.rst | 8 - docs/classes/singer_sdk.SQLConnector.rst | 8 - docs/classes/singer_sdk.SQLSink.rst | 8 - docs/classes/singer_sdk.SQLStream.rst | 8 - docs/classes/singer_sdk.SQLTap.rst | 10 -- docs/classes/singer_sdk.SQLTarget.rst | 10 -- docs/classes/singer_sdk.Sink.rst | 8 - docs/classes/singer_sdk.Stream.rst | 8 - docs/classes/singer_sdk.Tap.rst | 10 -- docs/classes/singer_sdk.Target.rst | 10 -- ...dk.authenticators.APIAuthenticatorBase.rst | 8 - ...sdk.authenticators.APIKeyAuthenticator.rst | 8 - ..._sdk.authenticators.BasicAuthenticator.rst | 8 - ...uthenticators.BearerTokenAuthenticator.rst | 8 - ..._sdk.authenticators.OAuthAuthenticator.rst | 8 - ...k.authenticators.OAuthJWTAuthenticator.rst | 8 - ...sdk.authenticators.SimpleAuthenticator.rst | 8 - docs/classes/singer_sdk.batch.BaseBatcher.rst | 8 - .../singer_sdk.batch.JSONLinesBatcher.rst | 8 - ...ger_sdk.connectors.sql.SQLToJSONSchema.rst | 8 - ...r_sdk.exceptions.ConfigValidationError.rst | 8 - .../singer_sdk.exceptions.FatalAPIError.rst | 8 - ....exceptions.InvalidStreamSortException.rst | 8 - ...nger_sdk.exceptions.MapExpressionError.rst | 8 - ...dk.exceptions.MaxRecordsLimitException.rst | 8 - ...ceptions.RecordsWithoutSchemaException.rst | 8 - ...inger_sdk.exceptions.RetriableAPIError.rst | 8 - ...er_sdk.exceptions.StreamMapConfigError.rst | 8 - ....exceptions.TapStreamConnectionFailure.rst | 8 - ...sdk.exceptions.TooManyRecordsException.rst | 8 - ...singer_sdk.pagination.BaseAPIPaginator.rst | 8 - ...er_sdk.pagination.BaseHATEOASPaginator.rst | 8 - ...ger_sdk.pagination.BaseOffsetPaginator.rst | 8 - ...sdk.pagination.BasePageNumberPaginator.rst | 8 - ...ger_sdk.pagination.HeaderLinkPaginator.rst | 8 - ...inger_sdk.pagination.JSONPathPaginator.rst | 8 - ...gination.LegacyPaginatedStreamProtocol.rst | 8 - ...r_sdk.pagination.LegacyStreamPaginator.rst | 8 - ...r_sdk.pagination.SimpleHeaderPaginator.rst | 8 - ...ger_sdk.pagination.SinglePagePaginator.rst | 8 - .../typing/singer_sdk.typing.ArrayType.rst | 8 - .../typing/singer_sdk.typing.BooleanType.rst | 8 - .../typing/singer_sdk.typing.Constant.rst | 8 - .../typing/singer_sdk.typing.CustomType.rst | 8 - .../typing/singer_sdk.typing.DateTimeType.rst | 8 - .../typing/singer_sdk.typing.DateType.rst | 8 - .../singer_sdk.typing.DiscriminatedUnion.rst | 8 - .../typing/singer_sdk.typing.DurationType.rst | 8 - .../typing/singer_sdk.typing.EmailType.rst | 8 - .../typing/singer_sdk.typing.HostnameType.rst | 8 - .../typing/singer_sdk.typing.IPv4Type.rst | 8 - .../typing/singer_sdk.typing.IPv6Type.rst | 8 - .../typing/singer_sdk.typing.IntegerType.rst | 9 - .../singer_sdk.typing.JSONPointerType.rst | 8 - .../typing/singer_sdk.typing.NumberType.rst | 9 - .../typing/singer_sdk.typing.ObjectType.rst | 8 - .../typing/singer_sdk.typing.OneOf.rst | 8 - .../singer_sdk.typing.PropertiesList.rst | 8 - .../typing/singer_sdk.typing.Property.rst | 8 - .../typing/singer_sdk.typing.RegexType.rst | 8 - ...ger_sdk.typing.RelativeJSONPointerType.rst | 8 - .../typing/singer_sdk.typing.StringType.rst | 8 - .../typing/singer_sdk.typing.TimeType.rst | 8 - .../singer_sdk.typing.URITemplateType.rst | 8 - .../typing/singer_sdk.typing.URIType.rst | 8 - .../typing/singer_sdk.typing.UUIDType.rst | 8 - docs/conf.py | 34 ++++ docs/reference.rst | 154 ------------------ noxfile.py | 2 +- poetry.lock | 55 ++++++- pyproject.toml | 1 + 75 files changed, 90 insertions(+), 728 deletions(-) delete mode 100644 docs/classes/singer_sdk.BatchSink.rst delete mode 100644 docs/classes/singer_sdk.GraphQLStream.rst delete mode 100644 docs/classes/singer_sdk.InlineMapper.rst delete mode 100644 docs/classes/singer_sdk.RESTStream.rst delete mode 100644 docs/classes/singer_sdk.RecordSink.rst delete mode 100644 docs/classes/singer_sdk.SQLConnector.rst delete mode 100644 docs/classes/singer_sdk.SQLSink.rst delete mode 100644 docs/classes/singer_sdk.SQLStream.rst delete mode 100644 docs/classes/singer_sdk.SQLTap.rst delete mode 100644 docs/classes/singer_sdk.SQLTarget.rst delete mode 100644 docs/classes/singer_sdk.Sink.rst delete mode 100644 docs/classes/singer_sdk.Stream.rst delete mode 100644 docs/classes/singer_sdk.Tap.rst delete mode 100644 docs/classes/singer_sdk.Target.rst delete mode 100644 docs/classes/singer_sdk.authenticators.APIAuthenticatorBase.rst delete mode 100644 docs/classes/singer_sdk.authenticators.APIKeyAuthenticator.rst delete mode 100644 docs/classes/singer_sdk.authenticators.BasicAuthenticator.rst delete mode 100644 docs/classes/singer_sdk.authenticators.BearerTokenAuthenticator.rst delete mode 100644 docs/classes/singer_sdk.authenticators.OAuthAuthenticator.rst delete mode 100644 docs/classes/singer_sdk.authenticators.OAuthJWTAuthenticator.rst delete mode 100644 docs/classes/singer_sdk.authenticators.SimpleAuthenticator.rst delete mode 100644 docs/classes/singer_sdk.batch.BaseBatcher.rst delete mode 100644 docs/classes/singer_sdk.batch.JSONLinesBatcher.rst delete mode 100644 docs/classes/singer_sdk.connectors.sql.SQLToJSONSchema.rst delete mode 100644 docs/classes/singer_sdk.exceptions.ConfigValidationError.rst delete mode 100644 docs/classes/singer_sdk.exceptions.FatalAPIError.rst delete mode 100644 docs/classes/singer_sdk.exceptions.InvalidStreamSortException.rst delete mode 100644 docs/classes/singer_sdk.exceptions.MapExpressionError.rst delete mode 100644 docs/classes/singer_sdk.exceptions.MaxRecordsLimitException.rst delete mode 100644 docs/classes/singer_sdk.exceptions.RecordsWithoutSchemaException.rst delete mode 100644 docs/classes/singer_sdk.exceptions.RetriableAPIError.rst delete mode 100644 docs/classes/singer_sdk.exceptions.StreamMapConfigError.rst delete mode 100644 docs/classes/singer_sdk.exceptions.TapStreamConnectionFailure.rst delete mode 100644 docs/classes/singer_sdk.exceptions.TooManyRecordsException.rst delete mode 100644 docs/classes/singer_sdk.pagination.BaseAPIPaginator.rst delete mode 100644 docs/classes/singer_sdk.pagination.BaseHATEOASPaginator.rst delete mode 100644 docs/classes/singer_sdk.pagination.BaseOffsetPaginator.rst delete mode 100644 docs/classes/singer_sdk.pagination.BasePageNumberPaginator.rst delete mode 100644 docs/classes/singer_sdk.pagination.HeaderLinkPaginator.rst delete mode 100644 docs/classes/singer_sdk.pagination.JSONPathPaginator.rst delete mode 100644 docs/classes/singer_sdk.pagination.LegacyPaginatedStreamProtocol.rst delete mode 100644 docs/classes/singer_sdk.pagination.LegacyStreamPaginator.rst delete mode 100644 docs/classes/singer_sdk.pagination.SimpleHeaderPaginator.rst delete mode 100644 docs/classes/singer_sdk.pagination.SinglePagePaginator.rst delete mode 100644 docs/classes/typing/singer_sdk.typing.ArrayType.rst delete mode 100644 docs/classes/typing/singer_sdk.typing.BooleanType.rst delete mode 100644 docs/classes/typing/singer_sdk.typing.Constant.rst delete mode 100644 docs/classes/typing/singer_sdk.typing.CustomType.rst delete mode 100644 docs/classes/typing/singer_sdk.typing.DateTimeType.rst delete mode 100644 docs/classes/typing/singer_sdk.typing.DateType.rst delete mode 100644 docs/classes/typing/singer_sdk.typing.DiscriminatedUnion.rst delete mode 100644 docs/classes/typing/singer_sdk.typing.DurationType.rst delete mode 100644 docs/classes/typing/singer_sdk.typing.EmailType.rst delete mode 100644 docs/classes/typing/singer_sdk.typing.HostnameType.rst delete mode 100644 docs/classes/typing/singer_sdk.typing.IPv4Type.rst delete mode 100644 docs/classes/typing/singer_sdk.typing.IPv6Type.rst delete mode 100644 docs/classes/typing/singer_sdk.typing.IntegerType.rst delete mode 100644 docs/classes/typing/singer_sdk.typing.JSONPointerType.rst delete mode 100644 docs/classes/typing/singer_sdk.typing.NumberType.rst delete mode 100644 docs/classes/typing/singer_sdk.typing.ObjectType.rst delete mode 100644 docs/classes/typing/singer_sdk.typing.OneOf.rst delete mode 100644 docs/classes/typing/singer_sdk.typing.PropertiesList.rst delete mode 100644 docs/classes/typing/singer_sdk.typing.Property.rst delete mode 100644 docs/classes/typing/singer_sdk.typing.RegexType.rst delete mode 100644 docs/classes/typing/singer_sdk.typing.RelativeJSONPointerType.rst delete mode 100644 docs/classes/typing/singer_sdk.typing.StringType.rst delete mode 100644 docs/classes/typing/singer_sdk.typing.TimeType.rst delete mode 100644 docs/classes/typing/singer_sdk.typing.URITemplateType.rst delete mode 100644 docs/classes/typing/singer_sdk.typing.URIType.rst delete mode 100644 docs/classes/typing/singer_sdk.typing.UUIDType.rst delete mode 100644 docs/reference.rst diff --git a/docs/classes/singer_sdk.BatchSink.rst b/docs/classes/singer_sdk.BatchSink.rst deleted file mode 100644 index ea6f276fb..000000000 --- a/docs/classes/singer_sdk.BatchSink.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.BatchSink -==================== - -.. currentmodule:: singer_sdk - -.. autoclass:: BatchSink - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.GraphQLStream.rst b/docs/classes/singer_sdk.GraphQLStream.rst deleted file mode 100644 index 41953196f..000000000 --- a/docs/classes/singer_sdk.GraphQLStream.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.GraphQLStream -======================== - -.. currentmodule:: singer_sdk - -.. autoclass:: GraphQLStream - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.InlineMapper.rst b/docs/classes/singer_sdk.InlineMapper.rst deleted file mode 100644 index a6e8b5e7b..000000000 --- a/docs/classes/singer_sdk.InlineMapper.rst +++ /dev/null @@ -1,10 +0,0 @@ -singer_sdk.InlineMapper -======================= - -.. currentmodule:: singer_sdk - -.. autoclass:: InlineMapper - :members: - :show-inheritance: - :inherited-members: - :special-members: __init__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.RESTStream.rst b/docs/classes/singer_sdk.RESTStream.rst deleted file mode 100644 index 9710c6303..000000000 --- a/docs/classes/singer_sdk.RESTStream.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.RESTStream -===================== - -.. currentmodule:: singer_sdk - -.. autoclass:: RESTStream - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.RecordSink.rst b/docs/classes/singer_sdk.RecordSink.rst deleted file mode 100644 index 1f087079e..000000000 --- a/docs/classes/singer_sdk.RecordSink.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.RecordSink -===================== - -.. currentmodule:: singer_sdk - -.. autoclass:: RecordSink - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.SQLConnector.rst b/docs/classes/singer_sdk.SQLConnector.rst deleted file mode 100644 index d4d097f8f..000000000 --- a/docs/classes/singer_sdk.SQLConnector.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.SQLConnector -======================= - -.. currentmodule:: singer_sdk - -.. autoclass:: SQLConnector - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.SQLSink.rst b/docs/classes/singer_sdk.SQLSink.rst deleted file mode 100644 index 60b8b14a4..000000000 --- a/docs/classes/singer_sdk.SQLSink.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.SQLSink -================== - -.. currentmodule:: singer_sdk - -.. autoclass:: SQLSink - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.SQLStream.rst b/docs/classes/singer_sdk.SQLStream.rst deleted file mode 100644 index f72894088..000000000 --- a/docs/classes/singer_sdk.SQLStream.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.SQLStream -==================== - -.. currentmodule:: singer_sdk - -.. autoclass:: SQLStream - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.SQLTap.rst b/docs/classes/singer_sdk.SQLTap.rst deleted file mode 100644 index 84433750f..000000000 --- a/docs/classes/singer_sdk.SQLTap.rst +++ /dev/null @@ -1,10 +0,0 @@ -singer_sdk.SQLTap -================= - -.. currentmodule:: singer_sdk - -.. 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 deleted file mode 100644 index 5c16f3f3f..000000000 --- a/docs/classes/singer_sdk.SQLTarget.rst +++ /dev/null @@ -1,10 +0,0 @@ -singer_sdk.SQLTarget -==================== - -.. currentmodule:: singer_sdk - -.. autoclass:: SQLTarget - :members: - :show-inheritance: - :inherited-members: - :special-members: __init__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.Sink.rst b/docs/classes/singer_sdk.Sink.rst deleted file mode 100644 index 79062c29e..000000000 --- a/docs/classes/singer_sdk.Sink.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.Sink -=============== - -.. currentmodule:: singer_sdk - -.. autoclass:: Sink - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.Stream.rst b/docs/classes/singer_sdk.Stream.rst deleted file mode 100644 index db028a912..000000000 --- a/docs/classes/singer_sdk.Stream.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.Stream -================= - -.. currentmodule:: singer_sdk - -.. autoclass:: Stream - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.Tap.rst b/docs/classes/singer_sdk.Tap.rst deleted file mode 100644 index cd6702fb5..000000000 --- a/docs/classes/singer_sdk.Tap.rst +++ /dev/null @@ -1,10 +0,0 @@ -singer_sdk.Tap -============== - -.. currentmodule:: singer_sdk - -.. 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 deleted file mode 100644 index 153479355..000000000 --- a/docs/classes/singer_sdk.Target.rst +++ /dev/null @@ -1,10 +0,0 @@ -singer_sdk.Target -================= - -.. currentmodule:: singer_sdk - -.. autoclass:: Target - :members: - :show-inheritance: - :inherited-members: - :special-members: __init__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.authenticators.APIAuthenticatorBase.rst b/docs/classes/singer_sdk.authenticators.APIAuthenticatorBase.rst deleted file mode 100644 index 1b3b608c5..000000000 --- a/docs/classes/singer_sdk.authenticators.APIAuthenticatorBase.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.authenticators.APIAuthenticatorBase -============================================== - -.. currentmodule:: singer_sdk.authenticators - -.. autoclass:: APIAuthenticatorBase - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.authenticators.APIKeyAuthenticator.rst b/docs/classes/singer_sdk.authenticators.APIKeyAuthenticator.rst deleted file mode 100644 index 28b0d7954..000000000 --- a/docs/classes/singer_sdk.authenticators.APIKeyAuthenticator.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.authenticators.APIKeyAuthenticator -============================================= - -.. currentmodule:: singer_sdk.authenticators - -.. autoclass:: APIKeyAuthenticator - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.authenticators.BasicAuthenticator.rst b/docs/classes/singer_sdk.authenticators.BasicAuthenticator.rst deleted file mode 100644 index e944212a7..000000000 --- a/docs/classes/singer_sdk.authenticators.BasicAuthenticator.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.authenticators.BasicAuthenticator -============================================ - -.. currentmodule:: singer_sdk.authenticators - -.. autoclass:: BasicAuthenticator - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.authenticators.BearerTokenAuthenticator.rst b/docs/classes/singer_sdk.authenticators.BearerTokenAuthenticator.rst deleted file mode 100644 index add92a271..000000000 --- a/docs/classes/singer_sdk.authenticators.BearerTokenAuthenticator.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.authenticators.BearerTokenAuthenticator -================================================== - -.. currentmodule:: singer_sdk.authenticators - -.. autoclass:: BearerTokenAuthenticator - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.authenticators.OAuthAuthenticator.rst b/docs/classes/singer_sdk.authenticators.OAuthAuthenticator.rst deleted file mode 100644 index 7600d45dc..000000000 --- a/docs/classes/singer_sdk.authenticators.OAuthAuthenticator.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.authenticators.OAuthAuthenticator -============================================ - -.. currentmodule:: singer_sdk.authenticators - -.. autoclass:: OAuthAuthenticator - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.authenticators.OAuthJWTAuthenticator.rst b/docs/classes/singer_sdk.authenticators.OAuthJWTAuthenticator.rst deleted file mode 100644 index 4fa2d3ea7..000000000 --- a/docs/classes/singer_sdk.authenticators.OAuthJWTAuthenticator.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.authenticators.OAuthJWTAuthenticator -=============================================== - -.. currentmodule:: singer_sdk.authenticators - -.. autoclass:: OAuthJWTAuthenticator - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.authenticators.SimpleAuthenticator.rst b/docs/classes/singer_sdk.authenticators.SimpleAuthenticator.rst deleted file mode 100644 index e83ef6fa1..000000000 --- a/docs/classes/singer_sdk.authenticators.SimpleAuthenticator.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.authenticators.SimpleAuthenticator -============================================= - -.. currentmodule:: singer_sdk.authenticators - -.. autoclass:: SimpleAuthenticator - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.batch.BaseBatcher.rst b/docs/classes/singer_sdk.batch.BaseBatcher.rst deleted file mode 100644 index 4b2588355..000000000 --- a/docs/classes/singer_sdk.batch.BaseBatcher.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.batch.BaseBatcher -============================ - -.. currentmodule:: singer_sdk.batch - -.. autoclass:: BaseBatcher - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.batch.JSONLinesBatcher.rst b/docs/classes/singer_sdk.batch.JSONLinesBatcher.rst deleted file mode 100644 index e03fa7e07..000000000 --- a/docs/classes/singer_sdk.batch.JSONLinesBatcher.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.batch.JSONLinesBatcher -================================= - -.. currentmodule:: singer_sdk.batch - -.. autoclass:: JSONLinesBatcher - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.connectors.sql.SQLToJSONSchema.rst b/docs/classes/singer_sdk.connectors.sql.SQLToJSONSchema.rst deleted file mode 100644 index 5f2acf693..000000000 --- a/docs/classes/singer_sdk.connectors.sql.SQLToJSONSchema.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.connectors.sql.SQLToJSONSchema -========================================= - -.. currentmodule:: singer_sdk.connectors.sql - -.. autoclass:: SQLToJSONSchema - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.exceptions.ConfigValidationError.rst b/docs/classes/singer_sdk.exceptions.ConfigValidationError.rst deleted file mode 100644 index 79f316f90..000000000 --- a/docs/classes/singer_sdk.exceptions.ConfigValidationError.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.exceptions.ConfigValidationError -=========================================== - -.. currentmodule:: singer_sdk.exceptions - -.. autoclass:: ConfigValidationError - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.exceptions.FatalAPIError.rst b/docs/classes/singer_sdk.exceptions.FatalAPIError.rst deleted file mode 100644 index 954b42f95..000000000 --- a/docs/classes/singer_sdk.exceptions.FatalAPIError.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.exceptions.FatalAPIError -=================================== - -.. currentmodule:: singer_sdk.exceptions - -.. autoclass:: FatalAPIError - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.exceptions.InvalidStreamSortException.rst b/docs/classes/singer_sdk.exceptions.InvalidStreamSortException.rst deleted file mode 100644 index e9bac24af..000000000 --- a/docs/classes/singer_sdk.exceptions.InvalidStreamSortException.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.exceptions.InvalidStreamSortException -================================================ - -.. currentmodule:: singer_sdk.exceptions - -.. autoclass:: InvalidStreamSortException - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.exceptions.MapExpressionError.rst b/docs/classes/singer_sdk.exceptions.MapExpressionError.rst deleted file mode 100644 index 21e543480..000000000 --- a/docs/classes/singer_sdk.exceptions.MapExpressionError.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.exceptions.MapExpressionError -======================================== - -.. currentmodule:: singer_sdk.exceptions - -.. autoclass:: MapExpressionError - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.exceptions.MaxRecordsLimitException.rst b/docs/classes/singer_sdk.exceptions.MaxRecordsLimitException.rst deleted file mode 100644 index 8492707f6..000000000 --- a/docs/classes/singer_sdk.exceptions.MaxRecordsLimitException.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.exceptions.MaxRecordsLimitException -============================================== - -.. currentmodule:: singer_sdk.exceptions - -.. autoclass:: MaxRecordsLimitException - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.exceptions.RecordsWithoutSchemaException.rst b/docs/classes/singer_sdk.exceptions.RecordsWithoutSchemaException.rst deleted file mode 100644 index 10d11cef4..000000000 --- a/docs/classes/singer_sdk.exceptions.RecordsWithoutSchemaException.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.exceptions.RecordsWithoutSchemaException -=================================================== - -.. currentmodule:: singer_sdk.exceptions - -.. autoclass:: RecordsWithoutSchemaException - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.exceptions.RetriableAPIError.rst b/docs/classes/singer_sdk.exceptions.RetriableAPIError.rst deleted file mode 100644 index 38f5c18e5..000000000 --- a/docs/classes/singer_sdk.exceptions.RetriableAPIError.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.exceptions.RetriableAPIError -======================================= - -.. currentmodule:: singer_sdk.exceptions - -.. autoclass:: RetriableAPIError - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.exceptions.StreamMapConfigError.rst b/docs/classes/singer_sdk.exceptions.StreamMapConfigError.rst deleted file mode 100644 index fc27ddec4..000000000 --- a/docs/classes/singer_sdk.exceptions.StreamMapConfigError.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.exceptions.StreamMapConfigError -========================================== - -.. currentmodule:: singer_sdk.exceptions - -.. autoclass:: StreamMapConfigError - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.exceptions.TapStreamConnectionFailure.rst b/docs/classes/singer_sdk.exceptions.TapStreamConnectionFailure.rst deleted file mode 100644 index 4876e5018..000000000 --- a/docs/classes/singer_sdk.exceptions.TapStreamConnectionFailure.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.exceptions.TapStreamConnectionFailure -================================================ - -.. currentmodule:: singer_sdk.exceptions - -.. autoclass:: TapStreamConnectionFailure - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.exceptions.TooManyRecordsException.rst b/docs/classes/singer_sdk.exceptions.TooManyRecordsException.rst deleted file mode 100644 index ab9ddeb82..000000000 --- a/docs/classes/singer_sdk.exceptions.TooManyRecordsException.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.exceptions.TooManyRecordsException -============================================= - -.. currentmodule:: singer_sdk.exceptions - -.. autoclass:: TooManyRecordsException - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.pagination.BaseAPIPaginator.rst b/docs/classes/singer_sdk.pagination.BaseAPIPaginator.rst deleted file mode 100644 index dfbfbc421..000000000 --- a/docs/classes/singer_sdk.pagination.BaseAPIPaginator.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.pagination.BaseAPIPaginator -====================================== - -.. currentmodule:: singer_sdk.pagination - -.. autoclass:: BaseAPIPaginator - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.pagination.BaseHATEOASPaginator.rst b/docs/classes/singer_sdk.pagination.BaseHATEOASPaginator.rst deleted file mode 100644 index 1581fb722..000000000 --- a/docs/classes/singer_sdk.pagination.BaseHATEOASPaginator.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.pagination.BaseHATEOASPaginator -========================================== - -.. currentmodule:: singer_sdk.pagination - -.. autoclass:: BaseHATEOASPaginator - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.pagination.BaseOffsetPaginator.rst b/docs/classes/singer_sdk.pagination.BaseOffsetPaginator.rst deleted file mode 100644 index 1321997c8..000000000 --- a/docs/classes/singer_sdk.pagination.BaseOffsetPaginator.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.pagination.BaseOffsetPaginator -========================================= - -.. currentmodule:: singer_sdk.pagination - -.. autoclass:: BaseOffsetPaginator - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.pagination.BasePageNumberPaginator.rst b/docs/classes/singer_sdk.pagination.BasePageNumberPaginator.rst deleted file mode 100644 index 15821f06f..000000000 --- a/docs/classes/singer_sdk.pagination.BasePageNumberPaginator.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.pagination.BasePageNumberPaginator -============================================= - -.. currentmodule:: singer_sdk.pagination - -.. autoclass:: BasePageNumberPaginator - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.pagination.HeaderLinkPaginator.rst b/docs/classes/singer_sdk.pagination.HeaderLinkPaginator.rst deleted file mode 100644 index 8820562b9..000000000 --- a/docs/classes/singer_sdk.pagination.HeaderLinkPaginator.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.pagination.HeaderLinkPaginator -========================================= - -.. currentmodule:: singer_sdk.pagination - -.. autoclass:: HeaderLinkPaginator - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.pagination.JSONPathPaginator.rst b/docs/classes/singer_sdk.pagination.JSONPathPaginator.rst deleted file mode 100644 index ded926d7f..000000000 --- a/docs/classes/singer_sdk.pagination.JSONPathPaginator.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.pagination.JSONPathPaginator -======================================= - -.. currentmodule:: singer_sdk.pagination - -.. autoclass:: JSONPathPaginator - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.pagination.LegacyPaginatedStreamProtocol.rst b/docs/classes/singer_sdk.pagination.LegacyPaginatedStreamProtocol.rst deleted file mode 100644 index 153d83481..000000000 --- a/docs/classes/singer_sdk.pagination.LegacyPaginatedStreamProtocol.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.pagination.LegacyPaginatedStreamProtocol -=================================================== - -.. currentmodule:: singer_sdk.pagination - -.. autoclass:: LegacyPaginatedStreamProtocol - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.pagination.LegacyStreamPaginator.rst b/docs/classes/singer_sdk.pagination.LegacyStreamPaginator.rst deleted file mode 100644 index 3510a4852..000000000 --- a/docs/classes/singer_sdk.pagination.LegacyStreamPaginator.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.pagination.LegacyStreamPaginator -=========================================== - -.. currentmodule:: singer_sdk.pagination - -.. autoclass:: LegacyStreamPaginator - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.pagination.SimpleHeaderPaginator.rst b/docs/classes/singer_sdk.pagination.SimpleHeaderPaginator.rst deleted file mode 100644 index 494b92aac..000000000 --- a/docs/classes/singer_sdk.pagination.SimpleHeaderPaginator.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.pagination.SimpleHeaderPaginator -=========================================== - -.. currentmodule:: singer_sdk.pagination - -.. autoclass:: SimpleHeaderPaginator - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/singer_sdk.pagination.SinglePagePaginator.rst b/docs/classes/singer_sdk.pagination.SinglePagePaginator.rst deleted file mode 100644 index 332e86de2..000000000 --- a/docs/classes/singer_sdk.pagination.SinglePagePaginator.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.pagination.SinglePagePaginator -========================================= - -.. currentmodule:: singer_sdk.pagination - -.. autoclass:: SinglePagePaginator - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/typing/singer_sdk.typing.ArrayType.rst b/docs/classes/typing/singer_sdk.typing.ArrayType.rst deleted file mode 100644 index 4717acec8..000000000 --- a/docs/classes/typing/singer_sdk.typing.ArrayType.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.typing.ArrayType -=========================== - -.. currentmodule:: singer_sdk.typing - -.. autoclass:: ArrayType - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/typing/singer_sdk.typing.BooleanType.rst b/docs/classes/typing/singer_sdk.typing.BooleanType.rst deleted file mode 100644 index d0398a4d3..000000000 --- a/docs/classes/typing/singer_sdk.typing.BooleanType.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.typing.BooleanType -============================= - -.. currentmodule:: singer_sdk.typing - -.. autoclass:: BooleanType - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/typing/singer_sdk.typing.Constant.rst b/docs/classes/typing/singer_sdk.typing.Constant.rst deleted file mode 100644 index 248f7eb57..000000000 --- a/docs/classes/typing/singer_sdk.typing.Constant.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.typing.Constant -========================== - -.. currentmodule:: singer_sdk.typing - -.. autoclass:: Constant - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/typing/singer_sdk.typing.CustomType.rst b/docs/classes/typing/singer_sdk.typing.CustomType.rst deleted file mode 100644 index 9c53706e7..000000000 --- a/docs/classes/typing/singer_sdk.typing.CustomType.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.typing.CustomType -============================ - -.. currentmodule:: singer_sdk.typing - -.. autoclass:: CustomType - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/typing/singer_sdk.typing.DateTimeType.rst b/docs/classes/typing/singer_sdk.typing.DateTimeType.rst deleted file mode 100644 index 2f38e55c0..000000000 --- a/docs/classes/typing/singer_sdk.typing.DateTimeType.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.typing.DateTimeType -============================== - -.. currentmodule:: singer_sdk.typing - -.. autoclass:: DateTimeType - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/typing/singer_sdk.typing.DateType.rst b/docs/classes/typing/singer_sdk.typing.DateType.rst deleted file mode 100644 index 0ceb97934..000000000 --- a/docs/classes/typing/singer_sdk.typing.DateType.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.typing.DateType -========================== - -.. currentmodule:: singer_sdk.typing - -.. autoclass:: DateType - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/typing/singer_sdk.typing.DiscriminatedUnion.rst b/docs/classes/typing/singer_sdk.typing.DiscriminatedUnion.rst deleted file mode 100644 index 132e2ca0a..000000000 --- a/docs/classes/typing/singer_sdk.typing.DiscriminatedUnion.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.typing.DiscriminatedUnion -==================================== - -.. currentmodule:: singer_sdk.typing - -.. autoclass:: DiscriminatedUnion - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/typing/singer_sdk.typing.DurationType.rst b/docs/classes/typing/singer_sdk.typing.DurationType.rst deleted file mode 100644 index 5c4473697..000000000 --- a/docs/classes/typing/singer_sdk.typing.DurationType.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.typing.DurationType -============================== - -.. currentmodule:: singer_sdk.typing - -.. autoclass:: DurationType - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/typing/singer_sdk.typing.EmailType.rst b/docs/classes/typing/singer_sdk.typing.EmailType.rst deleted file mode 100644 index e5fb94668..000000000 --- a/docs/classes/typing/singer_sdk.typing.EmailType.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.typing.EmailType -=========================== - -.. currentmodule:: singer_sdk.typing - -.. autoclass:: EmailType - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/typing/singer_sdk.typing.HostnameType.rst b/docs/classes/typing/singer_sdk.typing.HostnameType.rst deleted file mode 100644 index 25b44d844..000000000 --- a/docs/classes/typing/singer_sdk.typing.HostnameType.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.typing.HostnameType -============================== - -.. currentmodule:: singer_sdk.typing - -.. autoclass:: HostnameType - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/typing/singer_sdk.typing.IPv4Type.rst b/docs/classes/typing/singer_sdk.typing.IPv4Type.rst deleted file mode 100644 index e164f2eeb..000000000 --- a/docs/classes/typing/singer_sdk.typing.IPv4Type.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.typing.IPv4Type -========================== - -.. currentmodule:: singer_sdk.typing - -.. autoclass:: IPv4Type - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/typing/singer_sdk.typing.IPv6Type.rst b/docs/classes/typing/singer_sdk.typing.IPv6Type.rst deleted file mode 100644 index d67d4ce05..000000000 --- a/docs/classes/typing/singer_sdk.typing.IPv6Type.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.typing.IPv6Type -========================== - -.. currentmodule:: singer_sdk.typing - -.. autoclass:: IPv6Type - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/typing/singer_sdk.typing.IntegerType.rst b/docs/classes/typing/singer_sdk.typing.IntegerType.rst deleted file mode 100644 index b2097acae..000000000 --- a/docs/classes/typing/singer_sdk.typing.IntegerType.rst +++ /dev/null @@ -1,9 +0,0 @@ -singer_sdk.typing.IntegerType -============================= - -.. currentmodule:: singer_sdk.typing - -.. autoclass:: IntegerType - :members: - :special-members: __init__, __call__ - :inherited-members: JSONTypeHelper \ No newline at end of file diff --git a/docs/classes/typing/singer_sdk.typing.JSONPointerType.rst b/docs/classes/typing/singer_sdk.typing.JSONPointerType.rst deleted file mode 100644 index c2913e780..000000000 --- a/docs/classes/typing/singer_sdk.typing.JSONPointerType.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.typing.JSONPointerType -================================= - -.. currentmodule:: singer_sdk.typing - -.. autoclass:: JSONPointerType - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/typing/singer_sdk.typing.NumberType.rst b/docs/classes/typing/singer_sdk.typing.NumberType.rst deleted file mode 100644 index 09c29edf9..000000000 --- a/docs/classes/typing/singer_sdk.typing.NumberType.rst +++ /dev/null @@ -1,9 +0,0 @@ -singer_sdk.typing.NumberType -============================ - -.. currentmodule:: singer_sdk.typing - -.. autoclass:: NumberType - :members: - :special-members: __init__, __call__ - :inherited-members: JSONTypeHelper \ No newline at end of file diff --git a/docs/classes/typing/singer_sdk.typing.ObjectType.rst b/docs/classes/typing/singer_sdk.typing.ObjectType.rst deleted file mode 100644 index 5ce49a706..000000000 --- a/docs/classes/typing/singer_sdk.typing.ObjectType.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.typing.ObjectType -============================ - -.. currentmodule:: singer_sdk.typing - -.. autoclass:: ObjectType - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/typing/singer_sdk.typing.OneOf.rst b/docs/classes/typing/singer_sdk.typing.OneOf.rst deleted file mode 100644 index e9f159fe9..000000000 --- a/docs/classes/typing/singer_sdk.typing.OneOf.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.typing.OneOf -======================= - -.. currentmodule:: singer_sdk.typing - -.. autoclass:: OneOf - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/typing/singer_sdk.typing.PropertiesList.rst b/docs/classes/typing/singer_sdk.typing.PropertiesList.rst deleted file mode 100644 index 47a68ffca..000000000 --- a/docs/classes/typing/singer_sdk.typing.PropertiesList.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.typing.PropertiesList -================================ - -.. currentmodule:: singer_sdk.typing - -.. autoclass:: PropertiesList - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/typing/singer_sdk.typing.Property.rst b/docs/classes/typing/singer_sdk.typing.Property.rst deleted file mode 100644 index f2e67d933..000000000 --- a/docs/classes/typing/singer_sdk.typing.Property.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.typing.Property -========================== - -.. currentmodule:: singer_sdk.typing - -.. autoclass:: Property - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/typing/singer_sdk.typing.RegexType.rst b/docs/classes/typing/singer_sdk.typing.RegexType.rst deleted file mode 100644 index 1a04b9d83..000000000 --- a/docs/classes/typing/singer_sdk.typing.RegexType.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.typing.RegexType -=========================== - -.. currentmodule:: singer_sdk.typing - -.. autoclass:: RegexType - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/typing/singer_sdk.typing.RelativeJSONPointerType.rst b/docs/classes/typing/singer_sdk.typing.RelativeJSONPointerType.rst deleted file mode 100644 index ff597970c..000000000 --- a/docs/classes/typing/singer_sdk.typing.RelativeJSONPointerType.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.typing.RelativeJSONPointerType -========================================= - -.. currentmodule:: singer_sdk.typing - -.. autoclass:: RelativeJSONPointerType - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/typing/singer_sdk.typing.StringType.rst b/docs/classes/typing/singer_sdk.typing.StringType.rst deleted file mode 100644 index 633dde7dc..000000000 --- a/docs/classes/typing/singer_sdk.typing.StringType.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.typing.StringType -============================ - -.. currentmodule:: singer_sdk.typing - -.. autoclass:: StringType - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/typing/singer_sdk.typing.TimeType.rst b/docs/classes/typing/singer_sdk.typing.TimeType.rst deleted file mode 100644 index 929143ef6..000000000 --- a/docs/classes/typing/singer_sdk.typing.TimeType.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.typing.TimeType -========================== - -.. currentmodule:: singer_sdk.typing - -.. autoclass:: TimeType - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/typing/singer_sdk.typing.URITemplateType.rst b/docs/classes/typing/singer_sdk.typing.URITemplateType.rst deleted file mode 100644 index 77c082b8b..000000000 --- a/docs/classes/typing/singer_sdk.typing.URITemplateType.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.typing.URITemplateType -================================= - -.. currentmodule:: singer_sdk.typing - -.. autoclass:: URITemplateType - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/typing/singer_sdk.typing.URIType.rst b/docs/classes/typing/singer_sdk.typing.URIType.rst deleted file mode 100644 index 0111c4c22..000000000 --- a/docs/classes/typing/singer_sdk.typing.URIType.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.typing.URIType -========================= - -.. currentmodule:: singer_sdk.typing - -.. autoclass:: URIType - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/classes/typing/singer_sdk.typing.UUIDType.rst b/docs/classes/typing/singer_sdk.typing.UUIDType.rst deleted file mode 100644 index d4358e74c..000000000 --- a/docs/classes/typing/singer_sdk.typing.UUIDType.rst +++ /dev/null @@ -1,8 +0,0 @@ -singer_sdk.typing.UUIDType -========================== - -.. currentmodule:: singer_sdk.typing - -.. autoclass:: UUIDType - :members: - :special-members: __init__, __call__ \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index f2ee91c7a..d6c906cf5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -45,6 +45,8 @@ "sphinx.ext.extlinks", "sphinx.ext.intersphinx", "sphinx.ext.linkcode", + # Third-party extensions + "autoapi.extension", "sphinx_copybutton", "myst_parser", "sphinx_reredirects", @@ -175,6 +177,38 @@ # -- Options for linkcode -------------------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/extensions/linkcode.html#configuration +# -- Options for autoapi --------------------------------------------------------------- +autoapi_dirs = ["../singer_sdk"] +autoapi_options = [ + "members", + "show-module-summary", + "special-members", +] + + +def skip_top_level_module(app, what: str, name: str, obj, skip: bool, options) -> bool: # noqa: ANN001, ARG001, FBT001 + """Skip top-level modules. + + Args: + app: Sphinx application object. + what: Type of the object. + name: Name of the object. + obj: Object itself. + skip: Skip flag. + options: Options. + + Returns: + A boolean. + """ + if name == "singer_sdk" and what == "module": + skip = True + + return skip + + +def setup(sphinx) -> None: # noqa: ANN001 + sphinx.connect("autoapi-skip-member", skip_top_level_module) + def linkcode_resolve(domain: str, info: dict) -> str | None: """Get URL to source code. diff --git a/docs/reference.rst b/docs/reference.rst deleted file mode 100644 index eeaf1b53a..000000000 --- a/docs/reference.rst +++ /dev/null @@ -1,154 +0,0 @@ -Classes Reference -================= - -.. currentmodule:: singer_sdk - -Plugin Classes --------------- - -.. autosummary:: - :toctree: classes - :template: plugin_class.rst - - Tap - Target - SQLTap - SQLTarget - InlineMapper - -Stream Classes --------------- - -.. autosummary:: - :toctree: classes - :template: class.rst - - Stream - RESTStream - GraphQLStream - SQLStream - -Sink Classes ------------- - -.. autosummary:: - :toctree: classes - :template: class.rst - - Sink - RecordSink - BatchSink - SQLSink - -SQL Connector for SQL Taps and Targets --------------------------------------- - -.. autosummary:: - :toctree: classes - :template: class.rst - - SQLConnector - -Authenticator Classes ---------------------- - -.. autosummary:: - :toctree: classes - :template: class.rst - - authenticators.APIAuthenticatorBase - authenticators.APIKeyAuthenticator - authenticators.BasicAuthenticator - authenticators.BearerTokenAuthenticator - authenticators.OAuthAuthenticator - authenticators.OAuthJWTAuthenticator - authenticators.SimpleAuthenticator - -Exception Types ---------------- - -.. autosummary:: - :toctree: classes - :template: class.rst - - exceptions.ConfigValidationError - exceptions.FatalAPIError - exceptions.InvalidStreamSortException - exceptions.MapExpressionError - exceptions.MaxRecordsLimitException - exceptions.RecordsWithoutSchemaException - exceptions.RetriableAPIError - exceptions.StreamMapConfigError - exceptions.TapStreamConnectionFailure - exceptions.TooManyRecordsException - -JSON Schema builder classes ---------------------------- - -.. autosummary:: - :toctree: classes/typing - :template: class.rst - - typing.PropertiesList - typing.ArrayType - typing.BooleanType - typing.Constant - typing.CustomType - typing.DateTimeType - typing.DateType - typing.DiscriminatedUnion - typing.DurationType - typing.EmailType - typing.HostnameType - typing.IntegerType - typing.IPv4Type - typing.IPv6Type - typing.JSONPointerType - typing.NumberType - typing.ObjectType - typing.OneOf - typing.Property - typing.RegexType - typing.RelativeJSONPointerType - typing.StringType - typing.TimeType - typing.URITemplateType - typing.URIType - typing.UUIDType - -Pagination ----------- - -.. autosummary:: - :toctree: classes - :template: class.rst - - pagination.BaseAPIPaginator - pagination.SinglePagePaginator - pagination.BaseHATEOASPaginator - pagination.HeaderLinkPaginator - pagination.JSONPathPaginator - pagination.SimpleHeaderPaginator - pagination.BasePageNumberPaginator - pagination.BaseOffsetPaginator - pagination.LegacyPaginatedStreamProtocol - pagination.LegacyStreamPaginator - -Batch ------ - -.. autosummary:: - :toctree: classes - :template: class.rst - - batch.BaseBatcher - batch.JSONLinesBatcher - -Other ------ - -.. autosummary:: - :toctree: classes - :template: class.rst - - connectors.sql.SQLToJSONSchema diff --git a/noxfile.py b/noxfile.py index a6c4b6394..1f8564238 100644 --- a/noxfile.py +++ b/noxfile.py @@ -152,7 +152,7 @@ def coverage(session: nox.Session) -> None: @nox.session(name="docs", python=main_python_version) def docs(session: nox.Session) -> None: """Build the documentation.""" - args = session.posargs or ["docs", "build", "-W"] + args = session.posargs or ["docs", "build"] if not session.posargs and "FORCE_COLOR" in os.environ: args.insert(0, "--color") diff --git a/poetry.lock b/poetry.lock index 577c5d8ff..617a36b63 100644 --- a/poetry.lock +++ b/poetry.lock @@ -198,6 +198,20 @@ files = [ {file = "appdirs-1.4.4.tar.gz", hash = "sha256:7d5d0167b2b1ba821647616af46a749d1c653740dd0d2415100fe26e27afdf41"}, ] +[[package]] +name = "astroid" +version = "3.3.5" +description = "An abstract syntax tree for Python with inference support." +optional = true +python-versions = ">=3.9.0" +files = [ + {file = "astroid-3.3.5-py3-none-any.whl", hash = "sha256:a9d1c946ada25098d790e079ba2a1b112157278f3fb7e718ae6a9252f5835dc8"}, + {file = "astroid-3.3.5.tar.gz", hash = "sha256:5cfc40ae9f68311075d27ef68a4841bdc5cc7f6cf86671b49f00607d30188e2d"}, +] + +[package.dependencies] +typing-extensions = {version = ">=4.0.0", markers = "python_version < \"3.11\""} + [[package]] name = "async-timeout" version = "4.0.3" @@ -3025,6 +3039,27 @@ docs = ["sphinxcontrib-websupport"] lint = ["flake8 (>=6.0)", "importlib-metadata (>=6.0)", "mypy (==1.10.1)", "pytest (>=6.0)", "ruff (==0.5.2)", "sphinx-lint (>=0.9)", "tomli (>=2)", "types-docutils (==0.21.0.20240711)", "types-requests (>=2.30.0)"] test = ["cython (>=3.0)", "defusedxml (>=0.7.1)", "pytest (>=8.0)", "setuptools (>=70.0)", "typing_extensions (>=4.9)"] +[[package]] +name = "sphinx-autoapi" +version = "3.3.3" +description = "Sphinx API documentation generator" +optional = true +python-versions = ">=3.8" +files = [ + {file = "sphinx_autoapi-3.3.3-py3-none-any.whl", hash = "sha256:5c7349b42d45a492a611cb81fb48583d5148e9eab7fc6b1f326dc9273b9191e3"}, + {file = "sphinx_autoapi-3.3.3.tar.gz", hash = "sha256:c44fd719580e9a3684ff82019f4f7f39fc970e3030ffd325936654a6f4d31f22"}, +] + +[package.dependencies] +astroid = [ + {version = ">=2.7", markers = "python_version < \"3.12\""}, + {version = ">=3.0.0a1", markers = "python_version >= \"3.12\""}, +] +Jinja2 = "*" +PyYAML = "*" +sphinx = ">=6.1.0" +stdlib_list = {version = "*", markers = "python_version < \"3.10\""} + [[package]] name = "sphinx-basic-ng" version = "1.0.0b2" @@ -3299,6 +3334,24 @@ postgresql-psycopgbinary = ["psycopg[binary] (>=3.0.7)"] pymysql = ["pymysql"] sqlcipher = ["sqlcipher3_binary"] +[[package]] +name = "stdlib-list" +version = "0.11.0" +description = "A list of Python Standard Libraries (2.7 through 3.12)." +optional = true +python-versions = ">=3.9" +files = [ + {file = "stdlib_list-0.11.0-py3-none-any.whl", hash = "sha256:8bf8decfffaaf273d4cfeb5bd852b910a00dec1037dcf163576803622bccf597"}, + {file = "stdlib_list-0.11.0.tar.gz", hash = "sha256:b74a7b643a77a12637e907f3f62f0ab9f67300bce4014f6b2d3c8b4c8fd63c66"}, +] + +[package.extras] +dev = ["build", "stdlib-list[doc,lint,test]"] +doc = ["furo", "sphinx"] +lint = ["mypy", "ruff"] +support = ["sphobjinv"] +test = ["coverage[toml]", "pytest", "pytest-cov"] + [[package]] name = "time-machine" version = "2.15.0" @@ -3810,4 +3863,4 @@ testing = ["pytest"] [metadata] lock-version = "2.0" python-versions = ">=3.8" -content-hash = "22dab2c83f8699338a49a77e1c1af382acec467805e24d6dd53b0f464f43f304" +content-hash = "7f6b2322f89a1b5f504987b046714dc6a0cca58c3a2354434480ad8792e5b606" diff --git a/pyproject.toml b/pyproject.toml index e175795dd..0d079533c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -71,6 +71,7 @@ typing-extensions = ">=4.5.0" furo = {version = ">=2024.5.6", python = ">=3.9", optional = true} myst-parser = {version = ">=3", python = ">=3.9", optional = true} sphinx = {version = ">=7", python = ">=3.9", optional = true} +sphinx-autoapi = {version = ">=3.3.3", python = ">=3.9", optional = true} sphinx-copybutton = {version = ">=0.5.2", python = ">=3.9", optional = true} sphinx-inline-tabs = {version = ">=2023.4.21", python = ">=3.9", optional = true} sphinx-notfound-page = {version = ">=1.0.0", python = ">=3.9", optional = true}