docs: Reorganize docs and add deprecation timeline (meltano#1353)

Co-authored-by: Ken Payne <[email protected]> Co-authored-by: Aaron ("AJ") Steers <[email protected]>
oviohub · Feb 8, 2023 · 92dd45a · 92dd45a
1 parent 89adc1b
commit 92dd45a
Show file tree

Hide file tree

Showing 49 changed files with 671 additions and 385 deletions.
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -218,4 +218,4 @@ All public modules in the SDK are checked for the presence of docstrings in clas
 ### What is Poetry and why do we need it?
 
 For more info on `Poetry` and `Pipx`, please see the topic in our
-[python tips](python_tips.md) guide.
+[python tips](../python_tips.md) guide.
diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css
diff --git a/docs/_templates/layout.html → docs/_templates/base.html b/docs/_templates/layout.html → docs/_templates/base.html
@@ -1,7 +1,16 @@
-{% extends '!layout.html' %}
+{% extends '!base.html' %}
 {% block extrahead %}
   <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=IBM+Plex+Sans&amp;display=swap">
   <link rel="apple-touch-icon" sizes="180x180" href="{{ pathto('_static/img/melty-apple-touch-icon.png', 1) }}">
   <link rel="icon" type="image/png" sizes="32x32" href="{{ pathto('_static/img/melty-favicon-32x32.png', 1) }}">
   <link rel="icon" type="image/png" sizes="16x16" href="{{ pathto('_static/img/melty-favicon-16x16.png', 1) }}">
+  <!-- Google tag (gtag.js) -->
+  <script async src="https://www.googletagmanager.com/gtag/js?id=GTM-WHJMBX2"></script>
+  <script>
+    window.dataLayer = window.dataLayer || [];
+    function gtag(){dataLayer.push(arguments);}
+    gtag('js', new Date());
+
+    gtag('config', 'GTM-WHJMBX2');
+  </script>
 {% endblock %}
diff --git a/docs/_templates/footer.html b/docs/_templates/footer.html
diff --git a/docs/classes/singer_sdk.InlineMapper.rst b/docs/classes/singer_sdk.InlineMapper.rst
@@ -7,4 +7,4 @@
     :members:
     :show-inheritance:
     :inherited-members:
-    :special-members: __init__, __call__
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.SQLTap.rst b/docs/classes/singer_sdk.SQLTap.rst
@@ -7,4 +7,4 @@
     :members:
     :show-inheritance:
     :inherited-members:
-    :special-members: __init__, __call__
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.SQLTarget.rst b/docs/classes/singer_sdk.SQLTarget.rst
@@ -7,4 +7,4 @@
     :members:
     :show-inheritance:
     :inherited-members:
-    :special-members: __init__, __call__
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.Tap.rst b/docs/classes/singer_sdk.Tap.rst
@@ -7,4 +7,4 @@
     :members:
     :show-inheritance:
     :inherited-members:
-    :special-members: __init__, __call__
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.Target.rst b/docs/classes/singer_sdk.Target.rst
@@ -7,4 +7,4 @@
     :members:
     :show-inheritance:
     :inherited-members:
-    :special-members: __init__, __call__
+    :special-members: __init__
diff --git a/docs/classes/typing/singer_sdk.typing.ArrayType.rst b/docs/classes/typing/singer_sdk.typing.ArrayType.rst
@@ -0,0 +1,8 @@
+singer_sdk.typing.ArrayType
+===========================
+
+.. currentmodule:: singer_sdk.typing
+
+.. autoclass:: ArrayType
+    :members:
+    :special-members: __init__, __call__
diff --git a/docs/classes/typing/singer_sdk.typing.BooleanType.rst b/docs/classes/typing/singer_sdk.typing.BooleanType.rst
@@ -0,0 +1,8 @@
+singer_sdk.typing.BooleanType
+=============================
+
+.. currentmodule:: singer_sdk.typing
+
+.. autoclass:: BooleanType
+    :members:
+    :special-members: __init__, __call__
diff --git a/docs/classes/typing/singer_sdk.typing.CustomType.rst b/docs/classes/typing/singer_sdk.typing.CustomType.rst
@@ -0,0 +1,8 @@
+singer_sdk.typing.CustomType
+============================
+
+.. currentmodule:: singer_sdk.typing
+
+.. autoclass:: CustomType
+    :members:
+    :special-members: __init__, __call__
diff --git a/docs/classes/typing/singer_sdk.typing.DateTimeType.rst b/docs/classes/typing/singer_sdk.typing.DateTimeType.rst
@@ -0,0 +1,8 @@
+singer_sdk.typing.DateTimeType
+==============================
+
+.. currentmodule:: singer_sdk.typing
+
+.. autoclass:: DateTimeType
+    :members:
+    :special-members: __init__, __call__
diff --git a/docs/classes/typing/singer_sdk.typing.DateType.rst b/docs/classes/typing/singer_sdk.typing.DateType.rst
@@ -0,0 +1,8 @@
+singer_sdk.typing.DateType
+==========================
+
+.. currentmodule:: singer_sdk.typing
+
+.. autoclass:: DateType
+    :members:
+    :special-members: __init__, __call__
diff --git a/docs/classes/typing/singer_sdk.typing.DurationType.rst b/docs/classes/typing/singer_sdk.typing.DurationType.rst
@@ -0,0 +1,8 @@
+singer_sdk.typing.DurationType
+==============================
+
+.. currentmodule:: singer_sdk.typing
+
+.. autoclass:: DurationType
+    :members:
+    :special-members: __init__, __call__
diff --git a/docs/classes/typing/singer_sdk.typing.EmailType.rst b/docs/classes/typing/singer_sdk.typing.EmailType.rst
@@ -0,0 +1,8 @@
+singer_sdk.typing.EmailType
+===========================
+
+.. currentmodule:: singer_sdk.typing
+
+.. autoclass:: EmailType
+    :members:
+    :special-members: __init__, __call__
diff --git a/docs/classes/typing/singer_sdk.typing.HostnameType.rst b/docs/classes/typing/singer_sdk.typing.HostnameType.rst
@@ -0,0 +1,8 @@
+singer_sdk.typing.HostnameType
+==============================
+
+.. currentmodule:: singer_sdk.typing
+
+.. autoclass:: HostnameType
+    :members:
+    :special-members: __init__, __call__
diff --git a/docs/classes/typing/singer_sdk.typing.IPv4Type.rst b/docs/classes/typing/singer_sdk.typing.IPv4Type.rst
@@ -0,0 +1,8 @@
+singer_sdk.typing.IPv4Type
+==========================
+
+.. currentmodule:: singer_sdk.typing
+
+.. autoclass:: IPv4Type
+    :members:
+    :special-members: __init__, __call__
diff --git a/docs/classes/typing/singer_sdk.typing.IPv6Type.rst b/docs/classes/typing/singer_sdk.typing.IPv6Type.rst
@@ -0,0 +1,8 @@
+singer_sdk.typing.IPv6Type
+==========================
+
+.. currentmodule:: singer_sdk.typing
+
+.. autoclass:: IPv6Type
+    :members:
+    :special-members: __init__, __call__
diff --git a/docs/classes/typing/singer_sdk.typing.IntegerType.rst b/docs/classes/typing/singer_sdk.typing.IntegerType.rst
@@ -0,0 +1,8 @@
+singer_sdk.typing.IntegerType
+=============================
+
+.. currentmodule:: singer_sdk.typing
+
+.. autoclass:: IntegerType
+    :members:
+    :special-members: __init__, __call__
diff --git a/docs/classes/typing/singer_sdk.typing.JSONPointerType.rst b/docs/classes/typing/singer_sdk.typing.JSONPointerType.rst
@@ -0,0 +1,8 @@
+singer_sdk.typing.JSONPointerType
+=================================
+
+.. currentmodule:: singer_sdk.typing
+
+.. autoclass:: JSONPointerType
+    :members:
+    :special-members: __init__, __call__
diff --git a/docs/classes/typing/singer_sdk.typing.NumberType.rst b/docs/classes/typing/singer_sdk.typing.NumberType.rst
@@ -0,0 +1,8 @@
+singer_sdk.typing.NumberType
+============================
+
+.. currentmodule:: singer_sdk.typing
+
+.. autoclass:: NumberType
+    :members:
+    :special-members: __init__, __call__
diff --git a/docs/classes/typing/singer_sdk.typing.ObjectType.rst b/docs/classes/typing/singer_sdk.typing.ObjectType.rst
@@ -0,0 +1,8 @@
+singer_sdk.typing.ObjectType
+============================
+
+.. currentmodule:: singer_sdk.typing
+
+.. autoclass:: ObjectType
+    :members:
+    :special-members: __init__, __call__
diff --git a/docs/classes/typing/singer_sdk.typing.PropertiesList.rst b/docs/classes/typing/singer_sdk.typing.PropertiesList.rst
@@ -0,0 +1,8 @@
+singer_sdk.typing.PropertiesList
+================================
+
+.. currentmodule:: singer_sdk.typing
+
+.. autoclass:: PropertiesList
+    :members:
+    :special-members: __init__, __call__
diff --git a/docs/classes/typing/singer_sdk.typing.Property.rst b/docs/classes/typing/singer_sdk.typing.Property.rst
@@ -0,0 +1,8 @@
+singer_sdk.typing.Property
+==========================
+
+.. currentmodule:: singer_sdk.typing
+
+.. autoclass:: Property
+    :members:
+    :special-members: __init__, __call__
diff --git a/docs/classes/typing/singer_sdk.typing.RegexType.rst b/docs/classes/typing/singer_sdk.typing.RegexType.rst
@@ -0,0 +1,8 @@
+singer_sdk.typing.RegexType
+===========================
+
+.. currentmodule:: singer_sdk.typing
+
+.. autoclass:: RegexType
+    :members:
+    :special-members: __init__, __call__
diff --git a/docs/classes/typing/singer_sdk.typing.RelativeJSONPointerType.rst b/docs/classes/typing/singer_sdk.typing.RelativeJSONPointerType.rst
@@ -0,0 +1,8 @@
+singer_sdk.typing.RelativeJSONPointerType
+=========================================
+
+.. currentmodule:: singer_sdk.typing
+
+.. autoclass:: RelativeJSONPointerType
+    :members:
+    :special-members: __init__, __call__
diff --git a/docs/classes/typing/singer_sdk.typing.StringType.rst b/docs/classes/typing/singer_sdk.typing.StringType.rst
@@ -0,0 +1,8 @@
+singer_sdk.typing.StringType
+============================
+
+.. currentmodule:: singer_sdk.typing
+
+.. autoclass:: StringType
+    :members:
+    :special-members: __init__, __call__
diff --git a/docs/classes/typing/singer_sdk.typing.TimeType.rst b/docs/classes/typing/singer_sdk.typing.TimeType.rst
@@ -0,0 +1,8 @@
+singer_sdk.typing.TimeType
+==========================
+
+.. currentmodule:: singer_sdk.typing
+
+.. autoclass:: TimeType
+    :members:
+    :special-members: __init__, __call__