diff --git a/docs/api/agent.rst b/docs/api/agent.rst index 465b6f66b..5c163f290 100644 --- a/docs/api/agent.rst +++ b/docs/api/agent.rst @@ -1,16 +1,14 @@ Agent ===== -The ``Agent`` class represents an agent resource in the Runloop platform. +.. tabs:: -Asynchronous API ----------------- + .. tab:: Async -.. automodule:: runloop_api_client.sdk.async_agent - :members: + .. automodule:: runloop_api_client.sdk.async_agent + :members: -Synchronous API ---------------- + .. tab:: Sync -.. automodule:: runloop_api_client.sdk.agent - :members: + .. automodule:: runloop_api_client.sdk.agent + :members: diff --git a/docs/api/axon.rst b/docs/api/axon.rst index c47da18c9..7bcbbcd13 100644 --- a/docs/api/axon.rst +++ b/docs/api/axon.rst @@ -1,21 +1,14 @@ Axon ==== -.. note:: +.. tabs:: - Axon APIs are in beta and may change. + .. tab:: Async -The ``Axon`` class provides event communication channels with support for -publish/subscribe messaging, server-sent events (SSE) streaming, and SQL operations. + .. automodule:: runloop_api_client.sdk.async_axon + :members: -Asynchronous API ----------------- + .. tab:: Sync -.. automodule:: runloop_api_client.sdk.async_axon - :members: - -Synchronous API ---------------- - -.. automodule:: runloop_api_client.sdk.axon - :members: + .. automodule:: runloop_api_client.sdk.axon + :members: diff --git a/docs/api/benchmark.rst b/docs/api/benchmark.rst index 4ad8fe9c3..3c61f8885 100644 --- a/docs/api/benchmark.rst +++ b/docs/api/benchmark.rst @@ -1,18 +1,14 @@ Benchmark ========= -The ``Benchmark`` class manages benchmarks that group multiple scenarios for -systematic evaluation. Use benchmarks to run and compare agent performance -across a suite of scenarios. +.. tabs:: -Asynchronous API ----------------- + .. tab:: Async -.. automodule:: runloop_api_client.sdk.async_benchmark - :members: + .. automodule:: runloop_api_client.sdk.async_benchmark + :members: -Synchronous API ---------------- + .. tab:: Sync -.. automodule:: runloop_api_client.sdk.benchmark - :members: + .. automodule:: runloop_api_client.sdk.benchmark + :members: diff --git a/docs/api/benchmark_run.rst b/docs/api/benchmark_run.rst index a1143cda9..585788569 100644 --- a/docs/api/benchmark_run.rst +++ b/docs/api/benchmark_run.rst @@ -1,17 +1,14 @@ Benchmark Run ============= -The ``BenchmarkRun`` class represents a running instance of a benchmark. -Use it to track progress, list scenario runs, and manage the benchmark lifecycle. +.. tabs:: -Asynchronous API ----------------- + .. tab:: Async -.. automodule:: runloop_api_client.sdk.async_benchmark_run - :members: + .. automodule:: runloop_api_client.sdk.async_benchmark_run + :members: -Synchronous API ---------------- + .. tab:: Sync -.. automodule:: runloop_api_client.sdk.benchmark_run - :members: + .. automodule:: runloop_api_client.sdk.benchmark_run + :members: diff --git a/docs/api/blueprint.rst b/docs/api/blueprint.rst index 561a2d948..368db83bc 100644 --- a/docs/api/blueprint.rst +++ b/docs/api/blueprint.rst @@ -1,17 +1,14 @@ Blueprint ========= -The ``Blueprint`` class represents a reusable devbox configuration built from a Dockerfile -and optional setup commands. Use blueprints to create pre-configured devbox environments. +.. tabs:: -Asynchronous API ----------------- + .. tab:: Async -.. automodule:: runloop_api_client.sdk.async_blueprint - :members: + .. automodule:: runloop_api_client.sdk.async_blueprint + :members: -Synchronous API ---------------- + .. tab:: Sync -.. automodule:: runloop_api_client.sdk.blueprint - :members: + .. automodule:: runloop_api_client.sdk.blueprint + :members: diff --git a/docs/api/core.rst b/docs/api/core.rst index 0121648ea..7f2eca847 100644 --- a/docs/api/core.rst +++ b/docs/api/core.rst @@ -1,23 +1,19 @@ Core Module =========== -The core module provides the main SDK entry points and operation manager classes. -Use :class:`~runloop_api_client.sdk.async_.AsyncRunloopSDK` for async/await code or -:class:`~runloop_api_client.sdk.sync.RunloopSDK` for synchronous code. +.. tabs:: -Asynchronous API ----------------- + .. tab:: Async -.. autoclass:: runloop_api_client.sdk.async_.AsyncRunloopSDK + .. autoclass:: runloop_api_client.sdk.async_.AsyncRunloopSDK -.. automodule:: runloop_api_client.sdk.async_ + .. automodule:: runloop_api_client.sdk.async_ -Synchronous API ---------------- + .. tab:: Sync -.. autoclass:: runloop_api_client.sdk.sync.RunloopSDK + .. autoclass:: runloop_api_client.sdk.sync.RunloopSDK -.. automodule:: runloop_api_client.sdk.sync + .. automodule:: runloop_api_client.sdk.sync Base REST Client ---------------- diff --git a/docs/api/devbox.rst b/docs/api/devbox.rst index b38dcd6e3..777f80a69 100644 --- a/docs/api/devbox.rst +++ b/docs/api/devbox.rst @@ -1,18 +1,14 @@ Devbox ====== -The ``Devbox`` class provides methods for managing and interacting with a devbox instance, -including command execution, file operations, networking, and lifecycle management. -Devboxes support context manager usage for automatic cleanup. +.. tabs:: -Asynchronous API ----------------- + .. tab:: Async -.. automodule:: runloop_api_client.sdk.async_devbox - :members: + .. automodule:: runloop_api_client.sdk.async_devbox + :members: -Synchronous API ---------------- + .. tab:: Sync -.. automodule:: runloop_api_client.sdk.devbox - :members: + .. automodule:: runloop_api_client.sdk.devbox + :members: diff --git a/docs/api/execution.rst b/docs/api/execution.rst index a788f5e82..b4a69a0a4 100644 --- a/docs/api/execution.rst +++ b/docs/api/execution.rst @@ -1,17 +1,14 @@ Execution ========= -The ``Execution`` class represents an in-progress asynchronous command execution on a devbox. -Use it to track, wait for, or cancel long-running commands started with ``exec_async()``. +.. tabs:: -Asynchronous API ----------------- + .. tab:: Async -.. automodule:: runloop_api_client.sdk.async_execution - :members: + .. automodule:: runloop_api_client.sdk.async_execution + :members: -Synchronous API ---------------- + .. tab:: Sync -.. automodule:: runloop_api_client.sdk.execution - :members: + .. automodule:: runloop_api_client.sdk.execution + :members: diff --git a/docs/api/execution_result.rst b/docs/api/execution_result.rst index 36a230c2e..14fa31a5b 100644 --- a/docs/api/execution_result.rst +++ b/docs/api/execution_result.rst @@ -1,17 +1,14 @@ Execution Result ================ -The ``ExecutionResult`` class wraps the output of a completed command execution, -providing access to stdout, stderr, exit codes, and output parsing utilities. +.. tabs:: -Asynchronous API ----------------- + .. tab:: Async -.. automodule:: runloop_api_client.sdk.async_execution_result - :members: + .. automodule:: runloop_api_client.sdk.async_execution_result + :members: -Synchronous API ---------------- + .. tab:: Sync -.. automodule:: runloop_api_client.sdk.execution_result - :members: + .. automodule:: runloop_api_client.sdk.execution_result + :members: diff --git a/docs/api/gateway_config.rst b/docs/api/gateway_config.rst index 75600378b..d14c128c6 100644 --- a/docs/api/gateway_config.rst +++ b/docs/api/gateway_config.rst @@ -1,17 +1,14 @@ Gateway Config ============== -The ``GatewayConfig`` class manages API gateway configurations that proxy -requests through devboxes with credential management and authentication. +.. tabs:: -Asynchronous API ----------------- + .. tab:: Async -.. automodule:: runloop_api_client.sdk.async_gateway_config - :members: + .. automodule:: runloop_api_client.sdk.async_gateway_config + :members: -Synchronous API ---------------- + .. tab:: Sync -.. automodule:: runloop_api_client.sdk.gateway_config - :members: + .. automodule:: runloop_api_client.sdk.gateway_config + :members: diff --git a/docs/api/mcp_config.rst b/docs/api/mcp_config.rst index 000101aa0..8348041bc 100644 --- a/docs/api/mcp_config.rst +++ b/docs/api/mcp_config.rst @@ -1,17 +1,14 @@ MCP Config ========== -The ``McpConfig`` class manages Model Context Protocol (MCP) server configurations -that can be attached to devboxes, defining which MCP servers and tools are available. +.. tabs:: -Asynchronous API ----------------- + .. tab:: Async -.. automodule:: runloop_api_client.sdk.async_mcp_config - :members: + .. automodule:: runloop_api_client.sdk.async_mcp_config + :members: -Synchronous API ---------------- + .. tab:: Sync -.. automodule:: runloop_api_client.sdk.mcp_config - :members: + .. automodule:: runloop_api_client.sdk.mcp_config + :members: diff --git a/docs/api/network_policy.rst b/docs/api/network_policy.rst index d98c755b5..7be288420 100644 --- a/docs/api/network_policy.rst +++ b/docs/api/network_policy.rst @@ -1,17 +1,14 @@ Network Policy ============== -The ``NetworkPolicy`` class manages network access policies for devboxes, -controlling which hostnames and services a devbox can communicate with. +.. tabs:: -Asynchronous API ----------------- + .. tab:: Async -.. automodule:: runloop_api_client.sdk.async_network_policy - :members: + .. automodule:: runloop_api_client.sdk.async_network_policy + :members: -Synchronous API ---------------- + .. tab:: Sync -.. automodule:: runloop_api_client.sdk.network_policy - :members: + .. automodule:: runloop_api_client.sdk.network_policy + :members: diff --git a/docs/api/scenario.rst b/docs/api/scenario.rst index d6053d48c..7a3dc9497 100644 --- a/docs/api/scenario.rst +++ b/docs/api/scenario.rst @@ -1,17 +1,14 @@ Scenario ======== -The ``Scenario`` class represents a scenario for evaluating agent performance. -Scenarios define environments, problem statements, and scoring criteria. +.. tabs:: -Asynchronous API ----------------- + .. tab:: Async -.. automodule:: runloop_api_client.sdk.async_scenario - :members: + .. automodule:: runloop_api_client.sdk.async_scenario + :members: -Synchronous API ---------------- + .. tab:: Sync -.. automodule:: runloop_api_client.sdk.scenario - :members: + .. automodule:: runloop_api_client.sdk.scenario + :members: diff --git a/docs/api/scenario_builder.rst b/docs/api/scenario_builder.rst index 3bf0efeb0..8bd21aad7 100644 --- a/docs/api/scenario_builder.rst +++ b/docs/api/scenario_builder.rst @@ -1,18 +1,14 @@ Scenario Builder ================ -The ``ScenarioBuilder`` class provides a fluent API for constructing scenarios. -Chain methods to configure the environment, problem statement, and scoring criteria -before building or pushing the scenario. +.. tabs:: -Asynchronous API ----------------- + .. tab:: Async -.. automodule:: runloop_api_client.sdk.async_scenario_builder - :members: + .. automodule:: runloop_api_client.sdk.async_scenario_builder + :members: -Synchronous API ---------------- + .. tab:: Sync -.. automodule:: runloop_api_client.sdk.scenario_builder - :members: + .. automodule:: runloop_api_client.sdk.scenario_builder + :members: diff --git a/docs/api/scenario_run.rst b/docs/api/scenario_run.rst index 3b3d98f76..c98cec393 100644 --- a/docs/api/scenario_run.rst +++ b/docs/api/scenario_run.rst @@ -1,17 +1,14 @@ Scenario Run ============ -The ``ScenarioRun`` class represents a running instance of a scenario. -Use it to manage the run lifecycle, retrieve scores, and download logs. +.. tabs:: -Asynchronous API ----------------- + .. tab:: Async -.. automodule:: runloop_api_client.sdk.async_scenario_run - :members: + .. automodule:: runloop_api_client.sdk.async_scenario_run + :members: -Synchronous API ---------------- + .. tab:: Sync -.. automodule:: runloop_api_client.sdk.scenario_run - :members: + .. automodule:: runloop_api_client.sdk.scenario_run + :members: diff --git a/docs/api/scorer.rst b/docs/api/scorer.rst index dcbb51ba1..4caec75de 100644 --- a/docs/api/scorer.rst +++ b/docs/api/scorer.rst @@ -1,17 +1,14 @@ Scorer ====== -The ``Scorer`` class defines custom scoring logic for evaluating scenario outputs. -Scorers produce a score in the range [0.0, 1.0] for scenario runs. +.. tabs:: -Asynchronous API ----------------- + .. tab:: Async -.. automodule:: runloop_api_client.sdk.async_scorer - :members: + .. automodule:: runloop_api_client.sdk.async_scorer + :members: -Synchronous API ---------------- + .. tab:: Sync -.. automodule:: runloop_api_client.sdk.scorer - :members: + .. automodule:: runloop_api_client.sdk.scorer + :members: diff --git a/docs/api/secret.rst b/docs/api/secret.rst index 641e0b9ed..e04f1dfb9 100644 --- a/docs/api/secret.rst +++ b/docs/api/secret.rst @@ -1,17 +1,14 @@ Secret ====== -The ``Secret`` class manages encrypted key-value pairs that can be injected -into devbox environments as environment variables. +.. tabs:: -Asynchronous API ----------------- + .. tab:: Async -.. automodule:: runloop_api_client.sdk.async_secret - :members: + .. automodule:: runloop_api_client.sdk.async_secret + :members: -Synchronous API ---------------- + .. tab:: Sync -.. automodule:: runloop_api_client.sdk.secret - :members: + .. automodule:: runloop_api_client.sdk.secret + :members: diff --git a/docs/api/snapshot.rst b/docs/api/snapshot.rst index 1226dc250..7b8436d30 100644 --- a/docs/api/snapshot.rst +++ b/docs/api/snapshot.rst @@ -1,17 +1,14 @@ Snapshot ======== -The ``Snapshot`` class represents a point-in-time disk snapshot of a devbox. -Use snapshots to save and restore devbox state. +.. tabs:: -Asynchronous API ----------------- + .. tab:: Async -.. automodule:: runloop_api_client.sdk.async_snapshot - :members: + .. automodule:: runloop_api_client.sdk.async_snapshot + :members: -Synchronous API ---------------- + .. tab:: Sync -.. automodule:: runloop_api_client.sdk.snapshot - :members: + .. automodule:: runloop_api_client.sdk.snapshot + :members: diff --git a/docs/api/storage_object.rst b/docs/api/storage_object.rst index fd86df3f3..a78f26de1 100644 --- a/docs/api/storage_object.rst +++ b/docs/api/storage_object.rst @@ -1,17 +1,14 @@ Storage Object ============== -The ``StorageObject`` class manages file storage objects that can be uploaded, downloaded, -and mounted into devboxes. +.. tabs:: -Asynchronous API ----------------- + .. tab:: Async -.. automodule:: runloop_api_client.sdk.async_storage_object - :members: + .. automodule:: runloop_api_client.sdk.async_storage_object + :members: -Synchronous API ---------------- + .. tab:: Sync -.. automodule:: runloop_api_client.sdk.storage_object - :members: + .. automodule:: runloop_api_client.sdk.storage_object + :members: diff --git a/docs/conf.py b/docs/conf.py index d5a897e66..42c04c554 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -29,6 +29,7 @@ "sphinx.ext.viewcode", "sphinx_toolbox.more_autodoc.autotypeddict", "sphinx_autodoc_typehints", + "sphinx_tabs.tabs", ] templates_path = ["_templates"]