Skip to content

Commit 0b783f9

Browse files
sid-rlsid-rl
committed
docs: added Async vs Sync tabs, removed top-level class descriptions
1 parent 514cf93 commit 0b783f9

20 files changed

Lines changed: 134 additions & 197 deletions

‎docs/api/agent.rst‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
Agent
22
=====
33

4-
The ``Agent`` class represents an agent resource in the Runloop platform.
4+
.. tabs::
55

6-
Asynchronous API
7-
----------------
6+
.. tab:: Async
87

9-
.. automodule:: runloop_api_client.sdk.async_agent
10-
:members:
8+
.. automodule:: runloop_api_client.sdk.async_agent
9+
:members:
1110

12-
Synchronous API
13-
---------------
11+
.. tab:: Sync
1412

15-
.. automodule:: runloop_api_client.sdk.agent
16-
:members:
13+
.. automodule:: runloop_api_client.sdk.agent
14+
:members:

‎docs/api/axon.rst‎

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,14 @@
11
Axon
22
====
33

4-
.. note::
4+
.. tabs::
55

6-
Axon APIs are in beta and may change.
6+
.. tab:: Async
77

8-
The ``Axon`` class provides event communication channels with support for
9-
publish/subscribe messaging, server-sent events (SSE) streaming, and SQL operations.
8+
.. automodule:: runloop_api_client.sdk.async_axon
9+
:members:
1010

11-
Asynchronous API
12-
----------------
11+
.. tab:: Sync
1312

14-
.. automodule:: runloop_api_client.sdk.async_axon
15-
:members:
16-
17-
Synchronous API
18-
---------------
19-
20-
.. automodule:: runloop_api_client.sdk.axon
21-
:members:
13+
.. automodule:: runloop_api_client.sdk.axon
14+
:members:

‎docs/api/benchmark.rst‎

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,14 @@
11
Benchmark
22
=========
33

4-
The ``Benchmark`` class manages benchmarks that group multiple scenarios for
5-
systematic evaluation. Use benchmarks to run and compare agent performance
6-
across a suite of scenarios.
4+
.. tabs::
75

8-
Asynchronous API
9-
----------------
6+
.. tab:: Async
107

11-
.. automodule:: runloop_api_client.sdk.async_benchmark
12-
:members:
8+
.. automodule:: runloop_api_client.sdk.async_benchmark
9+
:members:
1310

14-
Synchronous API
15-
---------------
11+
.. tab:: Sync
1612

17-
.. automodule:: runloop_api_client.sdk.benchmark
18-
:members:
13+
.. automodule:: runloop_api_client.sdk.benchmark
14+
:members:

‎docs/api/benchmark_run.rst‎

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,14 @@
11
Benchmark Run
22
=============
33

4-
The ``BenchmarkRun`` class represents a running instance of a benchmark.
5-
Use it to track progress, list scenario runs, and manage the benchmark lifecycle.
4+
.. tabs::
65

7-
Asynchronous API
8-
----------------
6+
.. tab:: Async
97

10-
.. automodule:: runloop_api_client.sdk.async_benchmark_run
11-
:members:
8+
.. automodule:: runloop_api_client.sdk.async_benchmark_run
9+
:members:
1210

13-
Synchronous API
14-
---------------
11+
.. tab:: Sync
1512

16-
.. automodule:: runloop_api_client.sdk.benchmark_run
17-
:members:
13+
.. automodule:: runloop_api_client.sdk.benchmark_run
14+
:members:

‎docs/api/blueprint.rst‎

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,14 @@
11
Blueprint
22
=========
33

4-
The ``Blueprint`` class represents a reusable devbox configuration built from a Dockerfile
5-
and optional setup commands. Use blueprints to create pre-configured devbox environments.
4+
.. tabs::
65

7-
Asynchronous API
8-
----------------
6+
.. tab:: Async
97

10-
.. automodule:: runloop_api_client.sdk.async_blueprint
11-
:members:
8+
.. automodule:: runloop_api_client.sdk.async_blueprint
9+
:members:
1210

13-
Synchronous API
14-
---------------
11+
.. tab:: Sync
1512

16-
.. automodule:: runloop_api_client.sdk.blueprint
17-
:members:
13+
.. automodule:: runloop_api_client.sdk.blueprint
14+
:members:

‎docs/api/core.rst‎

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,19 @@
11
Core Module
22
===========
33

4-
The core module provides the main SDK entry points and operation manager classes.
5-
Use :class:`~runloop_api_client.sdk.async_.AsyncRunloopSDK` for async/await code or
6-
:class:`~runloop_api_client.sdk.sync.RunloopSDK` for synchronous code.
4+
.. tabs::
75

8-
Asynchronous API
9-
----------------
6+
.. tab:: Async
107

11-
.. autoclass:: runloop_api_client.sdk.async_.AsyncRunloopSDK
8+
.. autoclass:: runloop_api_client.sdk.async_.AsyncRunloopSDK
129

13-
.. automodule:: runloop_api_client.sdk.async_
10+
.. automodule:: runloop_api_client.sdk.async_
1411

15-
Synchronous API
16-
---------------
12+
.. tab:: Sync
1713

18-
.. autoclass:: runloop_api_client.sdk.sync.RunloopSDK
14+
.. autoclass:: runloop_api_client.sdk.sync.RunloopSDK
1915

20-
.. automodule:: runloop_api_client.sdk.sync
16+
.. automodule:: runloop_api_client.sdk.sync
2117

2218
Base REST Client
2319
----------------

‎docs/api/devbox.rst‎

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,14 @@
11
Devbox
22
======
33

4-
The ``Devbox`` class provides methods for managing and interacting with a devbox instance,
5-
including command execution, file operations, networking, and lifecycle management.
6-
Devboxes support context manager usage for automatic cleanup.
4+
.. tabs::
75

8-
Asynchronous API
9-
----------------
6+
.. tab:: Async
107

11-
.. automodule:: runloop_api_client.sdk.async_devbox
12-
:members:
8+
.. automodule:: runloop_api_client.sdk.async_devbox
9+
:members:
1310

14-
Synchronous API
15-
---------------
11+
.. tab:: Sync
1612

17-
.. automodule:: runloop_api_client.sdk.devbox
18-
:members:
13+
.. automodule:: runloop_api_client.sdk.devbox
14+
:members:

‎docs/api/execution.rst‎

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,14 @@
11
Execution
22
=========
33

4-
The ``Execution`` class represents an in-progress asynchronous command execution on a devbox.
5-
Use it to track, wait for, or cancel long-running commands started with ``exec_async()``.
4+
.. tabs::
65

7-
Asynchronous API
8-
----------------
6+
.. tab:: Async
97

10-
.. automodule:: runloop_api_client.sdk.async_execution
11-
:members:
8+
.. automodule:: runloop_api_client.sdk.async_execution
9+
:members:
1210

13-
Synchronous API
14-
---------------
11+
.. tab:: Sync
1512

16-
.. automodule:: runloop_api_client.sdk.execution
17-
:members:
13+
.. automodule:: runloop_api_client.sdk.execution
14+
:members:

‎docs/api/execution_result.rst‎

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,14 @@
11
Execution Result
22
================
33

4-
The ``ExecutionResult`` class wraps the output of a completed command execution,
5-
providing access to stdout, stderr, exit codes, and output parsing utilities.
4+
.. tabs::
65

7-
Asynchronous API
8-
----------------
6+
.. tab:: Async
97

10-
.. automodule:: runloop_api_client.sdk.async_execution_result
11-
:members:
8+
.. automodule:: runloop_api_client.sdk.async_execution_result
9+
:members:
1210

13-
Synchronous API
14-
---------------
11+
.. tab:: Sync
1512

16-
.. automodule:: runloop_api_client.sdk.execution_result
17-
:members:
13+
.. automodule:: runloop_api_client.sdk.execution_result
14+
:members:

‎docs/api/gateway_config.rst‎

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,14 @@
11
Gateway Config
22
==============
33

4-
The ``GatewayConfig`` class manages API gateway configurations that proxy
5-
requests through devboxes with credential management and authentication.
4+
.. tabs::
65

7-
Asynchronous API
8-
----------------
6+
.. tab:: Async
97

10-
.. automodule:: runloop_api_client.sdk.async_gateway_config
11-
:members:
8+
.. automodule:: runloop_api_client.sdk.async_gateway_config
9+
:members:
1210

13-
Synchronous API
14-
---------------
11+
.. tab:: Sync
1512

16-
.. automodule:: runloop_api_client.sdk.gateway_config
17-
:members:
13+
.. automodule:: runloop_api_client.sdk.gateway_config
14+
:members:

0 commit comments

Comments
 (0)