docs: integrate the SDM readme into pdoc (targets #620) (#621)

Author: aaronsteers

airbyte_cdk/__init__.py

@@ -32,6 +32,16 @@
 - `airbyte_cdk.models.airbyte_protocol`
 - `airbyte_cdk.models.airbyte_protocol_serializers`
 
+## Using the CLI (`airbyte_cdk.cli`)
+
+The Airbyte CDK provides two command-line interfaces (CLIs) for interacting with the framework.
+
+- `airbyte-cdk`: This is the main CLI for the Airbyte CDK. It provides commands for building
+  and testing connectors, as well as other utilities. See the `airbyte_cdk.cli.airbyte_cdk` module
+  for more details.
+- `source-declarative-manifest`: This command allows you to run declarative manifests directly.
+  See the `airbyte_cdk.cli.source_declarative_manifest` module for more details.
+
 ---
 
 API Reference

airbyte_cdk/cli/source_declarative_manifest/__init__.py

@@ -1,3 +1,8 @@
+"""
+.. include:: ./README.md
+   :start-line: 2
+"""
+
 from airbyte_cdk.cli.source_declarative_manifest._run import run
 
 __all__ = [

airbyte_cdk/cli/source_declarative_manifest/_run.py

@@ -299,5 +299,9 @@ def _register_components_from_file(filepath: str) -> None:
 
 
 def run() -> None:
+    """Run the `source-declarative-manifest` CLI.
+
+    Args are detected from the command line, and the appropriate command is executed.
+    """
     args: list[str] = sys.argv[1:]
     handle_command(args)