Revamp and fix docs

oviohub · May 25, 2022 · 81b99a1 · 81b99a1
1 parent 7c84336
commit 81b99a1
Show file tree

Hide file tree

Showing 51 changed files with 239 additions and 152 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -3,6 +3,7 @@ version: 2
 sphinx:
   builder: html
   configuration: docs/conf.py
+  fail_on_warning: true
 
 python:
   version: 3.8

diff --git a/docs/_templates/class.rst b/docs/_templates/class.rst
@@ -0,0 +1,7 @@
+{{ fullname }}
+{{ "=" * fullname|length }}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ name }}
+    :members:
diff --git a/docs/capabilities.rst b/docs/capabilities.rst
@@ -5,18 +5,18 @@ Plugin Capabilities
 Base Capabilities
 -------------------
 
-========
-Built-in
-========
+==========================
+Built-in base capabilities
+==========================
 
 The following capabilities are supported by default.
 
 .. autoattribute:: PluginCapabilities.ABOUT
 .. autoattribute:: PluginCapabilities.STREAM_MAPS
 
-======
-Custom
-======
+========================
+Custom base capabilities
+========================
 
 The following capabilities have to be implemented in the plugin.
 
@@ -28,9 +28,9 @@ Tap Capabilities
 
 .. currentmodule:: singer_sdk.helpers.capabilities
 
-========
-Built-in
-========
+=========================
+Built-in tap capabilities
+=========================
 
 The following capabilities are supported by default.
 
@@ -39,9 +39,9 @@ The following capabilities are supported by default.
 .. autoattribute:: TapCapabilities.STATE
 .. autoattribute:: TapCapabilities.TEST
 
-======
-Custom
-======
+=======================
+Custom tap capabilities
+=======================
 
 The following capabilities have to be implemented in the tap.
 
@@ -51,9 +51,9 @@ The following capabilities have to be implemented in the tap.
 Target Capabilities
 -------------------
 
-======
-Custom
-======
+==========================
+Custom target capabilities
+==========================
 
 The following capabilities have to be implemented in the target.
 

diff --git a/docs/classes/singer_sdk.BatchSink.rst b/docs/classes/singer_sdk.BatchSink.rst
@@ -1,7 +1,7 @@
-singer\_sdk.BatchSink
-==================
+singer_sdk.BatchSink
+====================
 
 .. currentmodule:: singer_sdk
 
 .. autoclass:: BatchSink
-    :members:
+    :members:
diff --git a/docs/classes/singer_sdk.GraphQLStream.rst b/docs/classes/singer_sdk.GraphQLStream.rst
@@ -1,7 +1,7 @@
-singer\_sdk.GraphQLStream
-=========================
+singer_sdk.GraphQLStream
+========================
 
 .. currentmodule:: singer_sdk
 
 .. autoclass:: GraphQLStream
-    :members:
+    :members:
diff --git a/docs/classes/singer_sdk.InlineMapper.rst b/docs/classes/singer_sdk.InlineMapper.rst
@@ -1,7 +1,7 @@
-singer\_sdk.InlineMapper
-========================
+singer_sdk.InlineMapper
+=======================
 
 .. currentmodule:: singer_sdk
 
 .. autoclass:: InlineMapper
-    :members:
+    :members:
diff --git a/docs/classes/singer_sdk.RESTStream.rst b/docs/classes/singer_sdk.RESTStream.rst
@@ -1,7 +1,7 @@
-singer\_sdk.RESTStream
-======================
+singer_sdk.RESTStream
+=====================
 
 .. currentmodule:: singer_sdk
 
 .. autoclass:: RESTStream
-    :members:
+    :members:
diff --git a/docs/classes/singer_sdk.RecordSink.rst b/docs/classes/singer_sdk.RecordSink.rst
@@ -1,7 +1,7 @@
-singer\_sdk.RecordSink
-==================
+singer_sdk.RecordSink
+=====================
 
 .. currentmodule:: singer_sdk
 
 .. autoclass:: RecordSink
-    :members:
+    :members:
diff --git a/docs/classes/singer_sdk.SQLConnector.rst b/docs/classes/singer_sdk.SQLConnector.rst
@@ -1,7 +1,7 @@
-singer\_sdk.SQLConnector
-======================
+singer_sdk.SQLConnector
+=======================
 
 .. currentmodule:: singer_sdk
 
 .. autoclass:: SQLConnector
-    :members:
+    :members:
diff --git a/docs/classes/singer_sdk.SQLSink.rst b/docs/classes/singer_sdk.SQLSink.rst
@@ -1,7 +1,7 @@
-singer\_sdk.SQLSink
-======================
+singer_sdk.SQLSink
+==================
 
 .. currentmodule:: singer_sdk
 
 .. autoclass:: SQLSink
-    :members:
+    :members:
diff --git a/docs/classes/singer_sdk.SQLStream.rst b/docs/classes/singer_sdk.SQLStream.rst
@@ -1,7 +1,7 @@
-singer\_sdk.SQLStream
-======================
+singer_sdk.SQLStream
+====================
 
 .. currentmodule:: singer_sdk
 
 .. autoclass:: SQLStream
-    :members:
+    :members:
diff --git a/docs/classes/singer_sdk.SQLTap.rst b/docs/classes/singer_sdk.SQLTap.rst
@@ -1,7 +1,7 @@
-singer\_sdk.SQLTap
-===============
+singer_sdk.SQLTap
+=================
 
 .. currentmodule:: singer_sdk
 
 .. autoclass:: SQLTap
-    :members:
+    :members:
diff --git a/docs/classes/singer_sdk.SQLTarget.rst b/docs/classes/singer_sdk.SQLTarget.rst
@@ -1,7 +1,7 @@
-singer\_sdk.SQLTarget
-===============
+singer_sdk.SQLTarget
+====================
 
 .. currentmodule:: singer_sdk
 
 .. autoclass:: SQLTarget
-    :members:
+    :members:
diff --git a/docs/classes/singer_sdk.Sink.rst b/docs/classes/singer_sdk.Sink.rst
@@ -1,7 +1,7 @@
-singer\_sdk.Sink
-==================
+singer_sdk.Sink
+===============
 
 .. currentmodule:: singer_sdk
 
 .. autoclass:: Sink
-    :members:
+    :members:
diff --git a/docs/classes/singer_sdk.Stream.rst b/docs/classes/singer_sdk.Stream.rst
@@ -1,7 +1,7 @@
-singer\_sdk.Stream
-==================
+singer_sdk.Stream
+=================
 
 .. currentmodule:: singer_sdk
 
 .. autoclass:: Stream
-    :members:
+    :members:
diff --git a/docs/classes/singer_sdk.Tap.rst b/docs/classes/singer_sdk.Tap.rst
@@ -1,7 +1,7 @@
-singer\_sdk.Tap
-===============
+singer_sdk.Tap
+==============
 
 .. currentmodule:: singer_sdk
 
 .. autoclass:: Tap
-    :members:
+    :members:
diff --git a/docs/classes/singer_sdk.Target.rst b/docs/classes/singer_sdk.Target.rst
@@ -1,7 +1,7 @@
-singer\_sdk.Target
-===============
+singer_sdk.Target
+=================
 
 .. currentmodule:: singer_sdk
 
 .. autoclass:: Target
-    :members:
+    :members:
diff --git a/docs/classes/singer_sdk.authenticators.APIKeyAuthenticator.rst b/docs/classes/singer_sdk.authenticators.APIKeyAuthenticator.rst
@@ -1,7 +1,7 @@
-singer\_sdk.authenticators.APIKeyAuthenticator
+singer_sdk.authenticators.APIKeyAuthenticator
 =============================================
 
 .. currentmodule:: singer_sdk.authenticators
 
 .. autoclass:: APIKeyAuthenticator
-    :members:
+    :members:
diff --git a/docs/classes/singer_sdk.authenticators.BasicAuthenticator.rst b/docs/classes/singer_sdk.authenticators.BasicAuthenticator.rst
@@ -1,7 +1,7 @@
-singer\_sdk.authenticators.BasicAuthenticator
-=============================================
+singer_sdk.authenticators.BasicAuthenticator
+============================================
 
 .. currentmodule:: singer_sdk.authenticators
 
 .. autoclass:: BasicAuthenticator
-    :members:
+    :members:
diff --git a/docs/classes/singer_sdk.authenticators.BearerTokenAuthenticator.rst b/docs/classes/singer_sdk.authenticators.BearerTokenAuthenticator.rst
@@ -1,7 +1,7 @@
-singer\_sdk.authenticators.BearerTokenAuthenticator
-=============================================
+singer_sdk.authenticators.BearerTokenAuthenticator
+==================================================
 
 .. currentmodule:: singer_sdk.authenticators
 
 .. autoclass:: BearerTokenAuthenticator
-    :members:
+    :members:
diff --git a/docs/classes/singer_sdk.authenticators.OAuthAuthenticator.rst b/docs/classes/singer_sdk.authenticators.OAuthAuthenticator.rst
@@ -1,7 +1,7 @@
-singer\_sdk.authenticators.OAuthAuthenticator
-=============================================
+singer_sdk.authenticators.OAuthAuthenticator
+============================================
 
 .. currentmodule:: singer_sdk.authenticators
 
 .. autoclass:: OAuthAuthenticator
-    :members:
+    :members:
diff --git a/docs/classes/singer_sdk.authenticators.OAuthJWTAuthenticator.rst b/docs/classes/singer_sdk.authenticators.OAuthJWTAuthenticator.rst
@@ -1,7 +1,7 @@
-singer\_sdk.authenticators.OAuthJWTAuthenticator
-================================================
+singer_sdk.authenticators.OAuthJWTAuthenticator
+===============================================
 
 .. currentmodule:: singer_sdk.authenticators
 
 .. autoclass:: OAuthJWTAuthenticator
-    :members:
+    :members:
diff --git a/docs/classes/singer_sdk.authenticators.SimpleAuthenticator.rst b/docs/classes/singer_sdk.authenticators.SimpleAuthenticator.rst
@@ -1,7 +1,7 @@
-singer\_sdk.authenticators.SimpleAuthenticator
-==============================================
+singer_sdk.authenticators.SimpleAuthenticator
+=============================================
 
 .. currentmodule:: singer_sdk.authenticators
 
 .. autoclass:: SimpleAuthenticator
-    :members:
+    :members:
diff --git a/docs/classes/singer_sdk.exceptions.ConfigValidationError.rst b/docs/classes/singer_sdk.exceptions.ConfigValidationError.rst
@@ -0,0 +1,7 @@
+singer_sdk.exceptions.ConfigValidationError
+===========================================
+
+.. currentmodule:: singer_sdk.exceptions
+
+.. autoclass:: ConfigValidationError
+    :members:
diff --git a/docs/classes/singer_sdk.exceptions.FatalAPIError.rst b/docs/classes/singer_sdk.exceptions.FatalAPIError.rst
@@ -1,6 +1,7 @@
-singer\_sdk.exceptions.FatalAPIError
-==============================================
+singer_sdk.exceptions.FatalAPIError
+===================================
 
 .. currentmodule:: singer_sdk.exceptions
 
-.. autoexception:: FatalAPIError
+.. autoclass:: FatalAPIError
+    :members:
diff --git a/docs/classes/singer_sdk.exceptions.InvalidStreamSortException.rst b/docs/classes/singer_sdk.exceptions.InvalidStreamSortException.rst
@@ -1,6 +1,7 @@
-singer\_sdk.exceptions.InvalidStreamSortException
-==============================================
+singer_sdk.exceptions.InvalidStreamSortException
+================================================
 
 .. currentmodule:: singer_sdk.exceptions
 
-.. autoexception:: InvalidStreamSortException
+.. autoclass:: InvalidStreamSortException
+    :members:
diff --git a/docs/classes/singer_sdk.exceptions.MapExpressionError.rst b/docs/classes/singer_sdk.exceptions.MapExpressionError.rst
@@ -0,0 +1,7 @@
+singer_sdk.exceptions.MapExpressionError
+========================================
+
+.. currentmodule:: singer_sdk.exceptions
+
+.. autoclass:: MapExpressionError
+    :members:
diff --git a/docs/classes/singer_sdk.exceptions.MaxRecordsLimitException.rst b/docs/classes/singer_sdk.exceptions.MaxRecordsLimitException.rst
@@ -1,6 +1,7 @@
-singer\_sdk.exceptions.MaxRecordsLimitException
+singer_sdk.exceptions.MaxRecordsLimitException
 ==============================================
 
 .. currentmodule:: singer_sdk.exceptions
 
-.. autoexception:: MaxRecordsLimitException
+.. autoclass:: MaxRecordsLimitException
+    :members:
diff --git a/docs/classes/singer_sdk.exceptions.RecordsWitoutSchemaException.rst b/docs/classes/singer_sdk.exceptions.RecordsWitoutSchemaException.rst
@@ -0,0 +1,7 @@
+singer_sdk.exceptions.RecordsWitoutSchemaException
+==================================================
+
+.. currentmodule:: singer_sdk.exceptions
+
+.. autoclass:: RecordsWitoutSchemaException
+    :members:
diff --git a/docs/classes/singer_sdk.exceptions.RetriableAPIError.rst b/docs/classes/singer_sdk.exceptions.RetriableAPIError.rst
@@ -1,6 +1,7 @@
-singer\_sdk.exceptions.RetriableAPIError
-==============================================
+singer_sdk.exceptions.RetriableAPIError
+=======================================
 
 .. currentmodule:: singer_sdk.exceptions
 
-.. autoexception:: RetriableAPIError
+.. autoclass:: RetriableAPIError
+    :members: