docs: Add reference docs for tap & target testing helpers (#2219)

Author: edgarrmondragon

docs/classes/singer_sdk.authenticators.APIAuthenticatorBase.rst

@@ -5,4 +5,4 @@
 
 .. autoclass:: APIAuthenticatorBase
     :members:
-    :special-members: __init__, __call__
+    :special-members: __init__, __call__

docs/conf.py

@@ -56,7 +56,7 @@
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # Show typehints in the description, along with parameter descriptions
-autodoc_typehints = "signature"
+autodoc_typehints = "description"
 autodoc_class_signature = "separated"
 autodoc_member_order = "groupwise"
 

docs/testing.md

@@ -10,7 +10,7 @@ The Meltano SDK test framework consists of 4 main components:
 1. A runner class (`TapTestRunner` and `TargetTestRunner`), responsible for executing Taps/Targets and capturing their output.
 1. A suite dataclass, containing a list of tests.
 1. A test template classes (`TapTestTemplate`, `StreamTestTemplate`, `AttributeTestTemplate` and `TargetTestTemplate`), with methods to `.setup()`, `.test()`, `.validate()` and `.teardown()` (called in that order using `.run()`).
-1. `get_tap_test_class` and `get_target_test_class` factory methods. These wrap a `get_test_class` factory method, which takes a runner and a list of suites and return a `pytest` test class.
+1. {func}`get_tap_test_class <singer_sdk.testing.get_tap_test_class>` and {func}`get_target_test_class <singer_sdk.testing.get_target_test_class>` factory methods. These wrap a `get_test_class` factory method, which takes a runner and a list of suites and return a `pytest` test class.
 
 ## Example Usage
 
@@ -76,7 +76,7 @@ class TestTargetExample(StandardTargetTests):
 
 ## Configuring Tests
 
-Test suite behaviors can be configured by passing a `SuiteConfig` instance to the `get_test_class` functions:
+Test suite behaviors can be configured by passing a {func}`SuiteConfig <singer_sdk.testing.SuiteConfig>` instance to the `get_test_class` functions:
 
 ```python
 from singer_sdk.testing import SuiteConfig, get_tap_test_class
@@ -101,7 +101,7 @@ TestTapStackExchange = get_tap_test_class(
 )
 ```
 
-Check out [`singer_sdk/testing/config.py`](https://github.com/meltano/sdk/tree/main/singer_sdk/testing/config.py) for available config options.
+Check out [the reference](#reference) for more information on the available configuration options.
 
 ## Writing New Tests
 
@@ -127,6 +127,21 @@ my_custom_tap_tests = TestSuite(
 )
 ```
 
-This suite can now be passed to `get_tap_test_class` or `get_target_test_class` in a list of `custom_suites` along with any other suites, to generate your custom test class.
+This suite can now be passed to {func}`get_tap_test_class <singer_sdk.testing.get_tap_test_class>` or {func}`get_target_test_class <singer_sdk.testing.get_target_test_class>` in a list of `custom_suites` along with any other suites, to generate your custom test class.
 
 If your new test covers a common or general case, consider contributing to the standard test library via a pull request to [meltano/sdk](https://github.com/meltano/sdk).
+
+## Reference
+
+```{eval-rst}
+.. autofunction:: singer_sdk.testing.get_tap_test_class
+```
+
+```{eval-rst}
+.. autofunction:: singer_sdk.testing.get_target_test_class
+```
+
+```{eval-rst}
+.. autoclass:: singer_sdk.testing.SuiteConfig
+    :members:
+```

poetry.lock

@@ -95,10 +95,11 @@ faker = {version = "~=22.5", optional = true}
 
 [tool.poetry.extras]
 docs = [
-    "sphinx",
     "furo",
-    "sphinx-copybutton",
     "myst-parser",
+    "pytest",
+    "sphinx",
+    "sphinx-copybutton",
     "sphinx-autobuild",
     "sphinx-inline-tabs",
     "sphinx-notfound-page",