docs: restructured sync vs async sdk and resources, added support for more type references (#679)

* reorganize structure + add relevant base api types

* don't document inheritance and undocumented members, and separate sync and async documentation into separate pages

* clean up class docstrings

* fix example type

* restructuring to give each resource a separate page

* renamed SDKDevboxExtraCreateParams to SDKDevboxCreateFromImageParams

* change type name in docs as well

Author: sid-rl

docs/api/index.rst

@@ -15,7 +15,6 @@
 project = "Runloop Python SDK"
 copyright = "2025, Runloop"
 author = "Runloop"
-release = "0.68.0"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -40,18 +39,9 @@
 
 # -- Extension configuration -------------------------------------------------
 
-# Napoleon settings
-napoleon_google_docstring = False
-napoleon_numpy_docstring = False
-napoleon_use_param = True
-napoleon_use_rtype = True
-napoleon_use_ivar = True
-
 # Autodoc settings
 autodoc_default_options = {
     "members": None,
-    "undoc-members": None,
-    "show-inheritance": None,
 }
 
 autodoc_typehints = "description"
@@ -60,5 +50,4 @@
 # Intersphinx mapping
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
-    "httpx": ("https://www.python-httpx.org", None),
 }

docs/conf.py

@@ -9,7 +9,7 @@ and asynchronous variants to match your runtime requirements.
    :maxdepth: 2
    :caption: Contents:
 
-   api/index
+   sdk/index
 
 Installation
 ------------
@@ -42,16 +42,16 @@ Asynchronous Example
 
 .. code-block:: python
 
+   import asyncio
    from runloop_api_client import AsyncRunloopSDK
 
    async def main():
        runloop = AsyncRunloopSDK()
        
-       async with runloop.devbox.create(name="my-devbox") as devbox:
+       async with await runloop.devbox.create(name="my-devbox") as devbox:
            result = await devbox.cmd.exec(command="echo 'Hello from Runloop!'")
            print(await result.stdout())
 
-   import asyncio
    asyncio.run(main())
 
 Indices and tables

docs/index.rst

@@ -0,0 +1,8 @@
+Blueprint
+=========
+
+The ``AsyncBlueprint`` class provides asynchronous methods for managing devbox blueprints.
+
+.. automodule:: runloop_api_client.sdk.async_blueprint
+   :members:
+

docs/sdk/async/blueprint.rst

@@ -0,0 +1,8 @@
+Devbox
+======
+
+The ``AsyncDevbox`` class provides asynchronous methods for managing and interacting with a devbox instance.
+
+.. automodule:: runloop_api_client.sdk.async_devbox
+   :members:
+

docs/sdk/async/devbox.rst

@@ -0,0 +1,8 @@
+Execution
+=========
+
+The ``AsyncExecution`` class represents an asynchronous command execution in progress.
+
+.. automodule:: runloop_api_client.sdk.async_execution
+   :members:
+

docs/sdk/async/execution.rst

@@ -0,0 +1,8 @@
+Execution Result
+================
+
+The ``AsyncExecutionResult`` class represents the result of a completed command execution.
+
+.. automodule:: runloop_api_client.sdk.async_execution_result
+   :members:
+

docs/sdk/async/execution_result.rst

@@ -0,0 +1,29 @@
+Asynchronous SDK
+================
+
+The asynchronous SDK provides a non-blocking interface for managing devboxes, blueprints, snapshots, and storage objects. Use this variant when working with async/await Python code.
+
+Core Module
+-----------
+
+The core asynchronous SDK module provides async operation classes.
+
+.. autoclass:: runloop_api_client.sdk.async_.AsyncRunloopSDK
+
+.. automodule:: runloop_api_client.sdk.async_
+
+Resource Modules
+----------------
+
+Asynchronous resource classes for working with devboxes, blueprints, snapshots, and more.
+
+.. toctree::
+   :maxdepth: 1
+
+   devbox
+   execution
+   execution_result
+   blueprint
+   snapshot
+   storage_object
+

docs/sdk/async/index.rst

@@ -0,0 +1,8 @@
+Snapshot
+========
+
+The ``AsyncSnapshot`` class provides asynchronous methods for managing devbox snapshots.
+
+.. automodule:: runloop_api_client.sdk.async_snapshot
+   :members:
+

docs/sdk/async/snapshot.rst

@@ -0,0 +1,8 @@
+Storage Object
+==============
+
+The ``AsyncStorageObject`` class provides asynchronous methods for managing storage objects.
+
+.. automodule:: runloop_api_client.sdk.async_storage_object
+   :members:
+