docs: Docs nav structure reorg follow-up (meltano#1407)

oviohub · Feb 10, 2023 · 3a18e74 · 3a18e74
1 parent 9966bdf
commit 3a18e74
Show file tree

Hide file tree

Showing 14 changed files with 35 additions and 39 deletions.
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -1,4 +1,4 @@
-# Contributing to the SDK
+# Contributing Guide
 
 _**Note:** The SDK currently works with Python versions 3.7 through 3.10.x. Python 3.6 is no longer supported._
 
@@ -214,7 +214,6 @@ Type hints allow us to spend less time reading documentation. Public modules are
 
 All public modules in the SDK are checked for the presence of docstrings in classes and functions. We follow the [Google Style convention](https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html) for Python docstrings so functions are required to have a description of every argument and the return value, if applicable.
 
-
 ### What is Poetry and why do we need it?
 
 For more info on `Poetry` and `Pipx`, please see the topic in our

diff --git a/docs/development/deprecation.md → docs/deprecation.md b/docs/development/deprecation.md → docs/deprecation.md
@@ -2,7 +2,7 @@
 
 This page outlines when various features of the Singer SDK will be removed or changed in a backward
 incompatible way, following their deprecation, as indicated in the
-[deprecation policy](./release-process.md#deprecation-policy).
+[deprecation policy](./release_process.md#deprecation-policy).
 
 ## 1.0
 

diff --git a/docs/development/index.md b/docs/development/index.md
diff --git a/docs/faq.md b/docs/faq.md
@@ -6,7 +6,7 @@ Most likely you should delete the project and start over.
 
 ## What are all of the Property options?
 
-The property types are documented in the [JSON Schema builder classes](./reference.rst).
+The property types are documented in the [JSON Schema helper classes](./reference.rst).
 However, if you're using an IDE such as VSCode, you should be able to set up the environment to give you autocompletion prompts or hints.
 Ensure your interpreter is set to poetry if you've followed the [Dev Guide](./dev_guide.md).
 Checkout this [gif](https://visualstudiomagazine.com/articles/2021/04/20/~/media/ECG/visualstudiomagazine/Images/2021/04/poetry.ashx) for how to change your interpreter.

diff --git a/docs/implementation/at_least_once.md b/docs/implementation/at_least_once.md
@@ -1,4 +1,4 @@
-# [SDK Implementation Details](./index.md) - "At Least Once" Delivery Promise
+# "At Least Once" Delivery Promise
 
 The Singer Spec promises that each record in the source system will be processed successfully in the target _at least once_. This promises that no record will ever go missing or be omitted, but it _does not_ guarantee that all records will be received _exactly once_.
 

diff --git a/docs/implementation/catalog_metadata.md b/docs/implementation/catalog_metadata.md
@@ -1,4 +1,4 @@
-# [SDK Implementation Details](./index.md) - Catalog Metadata
+# Catalog Metadata
 
 The SDK automatically generates catalog metadata during catalog discovery. Selection rules overrided by a user will be respected.
 

diff --git a/docs/implementation/logging.md b/docs/implementation/logging.md
@@ -1,4 +1,4 @@
-# [SDK Implementation Details](./index.md) - Logging
+# Logging
 
 ## Logging levels
 

diff --git a/docs/implementation/metrics.md b/docs/implementation/metrics.md
@@ -1,4 +1,4 @@
-# [SDK Implementation Details](./index.md) - Tap Metrics
+# Tap Metrics
 
 Metrics logging is specified in the
 [Singer Spec](https://hub.meltano.com/singer/spec#metrics). The SDK will automatically

diff --git a/docs/implementation/record_metadata.md b/docs/implementation/record_metadata.md
@@ -1,4 +1,4 @@
-# [SDK Implementation Details](./index.md) - Record Metadata
+# Record Metadata
 
 The SDK can automatically generate `_sdc_` ("Singer Data Capture") metadata properties when
 performing data loads in SDK-based targets.

diff --git a/docs/implementation/state.md b/docs/implementation/state.md
@@ -1,4 +1,4 @@
-# [SDK Implementation Details](./index.md) - Stream State
+# Stream State
 
 The SDK automatically handles state management and bookmarks.
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -46,7 +46,6 @@ within the `#singer-tap-development`_ and `#singer-target-development`_ Slack ch
    Python Tips <python_tips>
    Code Samples <code_samples>
    cli_commands
-   capabilities
    faq
 
 .. toctree::
@@ -55,6 +54,9 @@ within the `#singer-tap-development`_ and `#singer-target-development`_ Slack ch
    :hidden:
 
    reference
+   implementation/index
+   typing
+   capabilities
 
 .. toctree::
    :caption: Advanced Concepts
@@ -68,16 +70,16 @@ within the `#singer-tap-development`_ and `#singer-target-development`_ Slack ch
    stream_maps
    batch
    sinks
-   implementation/index
    testing
 
 .. toctree::
-   :caption: Development
+   :caption: SDK Development
    :maxdepth: 1
    :hidden:
 
    CONTRIBUTING
-   development/index
+   release_process
+   deprecation
 
 .. _Singer: https://singer.io
 .. _Singer Spec: https://hub.meltano.com/singer/spec

diff --git a/docs/reference.rst b/docs/reference.rst
@@ -89,29 +89,29 @@ JSON Schema builder classes
     :toctree: classes/typing
     :template: class.rst
 
-    typing.StringType
+    typing.PropertiesList
+    typing.ArrayType
+    typing.BooleanType
+    typing.CustomType
     typing.DateTimeType
-    typing.TimeType
     typing.DateType
     typing.DurationType
     typing.EmailType
     typing.HostnameType
+    typing.IntegerType
     typing.IPv4Type
     typing.IPv6Type
-    typing.UUIDType
-    typing.URIType
-    typing.URITemplateType
     typing.JSONPointerType
-    typing.RelativeJSONPointerType
-    typing.RegexType
-    typing.BooleanType
-    typing.IntegerType
     typing.NumberType
-    typing.ArrayType
-    typing.Property
     typing.ObjectType
-    typing.CustomType
-    typing.PropertiesList
+    typing.Property
+    typing.RegexType
+    typing.RelativeJSONPointerType
+    typing.StringType
+    typing.TimeType
+    typing.URITemplateType
+    typing.URIType
+    typing.UUIDType
 
 Pagination
 ----------

diff --git a/docs/development/release-process.md → docs/release_process.md b/docs/development/release-process.md → docs/release_process.md
@@ -2,7 +2,7 @@
 
 ## PyPI releases
 
-TODO: This section needs to be updated to reflect the release process.
+Releases are published to PyPI by a GitHub Actions workflow, triggered when a GitHub [Release](https://github.com/meltano/sdk/releases) is published.
 
 ### Feature releases
 

diff --git a/docs/typing.rst b/docs/typing.rst
@@ -0,0 +1,6 @@
+JSON Schema Helpers
+===================
+
+.. automodule:: singer_sdk.typing
+    :noindex:
+    :members: