Skip to content

Commit 4b0ef1c

Browse files
sid-rlsid-rl
committed
docs: restructure sphinx docs with async-first API reference and full type coverage
1 parent 6a76ed1 commit 4b0ef1c

44 files changed

Lines changed: 542 additions & 219 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/api/agent.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
Agent
2+
=====
3+
4+
The ``Agent`` class represents an agent resource in the Runloop platform.
5+
6+
Asynchronous API
7+
----------------
8+
9+
.. automodule:: runloop_api_client.sdk.async_agent
10+
:members:
11+
12+
Synchronous API
13+
---------------
14+
15+
.. automodule:: runloop_api_client.sdk.agent
16+
:members:

‎docs/api/axon.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
Axon
2+
====
3+
4+
.. note::
5+
6+
Axon APIs are in beta and may change.
7+
8+
The ``Axon`` class provides event communication channels with support for
9+
publish/subscribe messaging, server-sent events (SSE) streaming, and SQL operations.
10+
11+
Asynchronous API
12+
----------------
13+
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:

‎docs/api/benchmark.rst‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
Benchmark
2+
=========
3+
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.
7+
8+
Asynchronous API
9+
----------------
10+
11+
.. automodule:: runloop_api_client.sdk.async_benchmark
12+
:members:
13+
14+
Synchronous API
15+
---------------
16+
17+
.. automodule:: runloop_api_client.sdk.benchmark
18+
:members:

‎docs/api/benchmark_run.rst‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Benchmark Run
2+
=============
3+
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.
6+
7+
Asynchronous API
8+
----------------
9+
10+
.. automodule:: runloop_api_client.sdk.async_benchmark_run
11+
:members:
12+
13+
Synchronous API
14+
---------------
15+
16+
.. automodule:: runloop_api_client.sdk.benchmark_run
17+
:members:

‎docs/api/blueprint.rst‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Blueprint
2+
=========
3+
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.
6+
7+
Asynchronous API
8+
----------------
9+
10+
.. automodule:: runloop_api_client.sdk.async_blueprint
11+
:members:
12+
13+
Synchronous API
14+
---------------
15+
16+
.. automodule:: runloop_api_client.sdk.blueprint
17+
:members:

‎docs/api/core.rst‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
Core Module
2+
===========
3+
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.
7+
8+
Asynchronous API
9+
----------------
10+
11+
.. autoclass:: runloop_api_client.sdk.async_.AsyncRunloopSDK
12+
13+
.. automodule:: runloop_api_client.sdk.async_
14+
15+
Synchronous API
16+
---------------
17+
18+
.. autoclass:: runloop_api_client.sdk.sync.RunloopSDK
19+
20+
.. automodule:: runloop_api_client.sdk.sync
21+
22+
Base REST Client
23+
----------------
24+
25+
The SDK wraps the generated REST client. The ``api`` attribute on
26+
:class:`~runloop_api_client.sdk.async_.AsyncRunloopSDK` /
27+
:class:`~runloop_api_client.sdk.sync.RunloopSDK` provides direct access.
28+
29+
.. autoclass:: runloop_api_client.AsyncRunloop
30+
:no-members:
31+
32+
.. autoclass:: runloop_api_client.Runloop
33+
:no-members:

‎docs/api/devbox.rst‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
Devbox
2+
======
3+
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.
7+
8+
Asynchronous API
9+
----------------
10+
11+
.. automodule:: runloop_api_client.sdk.async_devbox
12+
:members:
13+
14+
Synchronous API
15+
---------------
16+
17+
.. automodule:: runloop_api_client.sdk.devbox
18+
:members:

‎docs/api/execution.rst‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Execution
2+
=========
3+
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()``.
6+
7+
Asynchronous API
8+
----------------
9+
10+
.. automodule:: runloop_api_client.sdk.async_execution
11+
:members:
12+
13+
Synchronous API
14+
---------------
15+
16+
.. automodule:: runloop_api_client.sdk.execution
17+
:members:

‎docs/api/execution_result.rst‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Execution Result
2+
================
3+
4+
The ``ExecutionResult`` class wraps the output of a completed command execution,
5+
providing access to stdout, stderr, exit codes, and output parsing utilities.
6+
7+
Asynchronous API
8+
----------------
9+
10+
.. automodule:: runloop_api_client.sdk.async_execution_result
11+
:members:
12+
13+
Synchronous API
14+
---------------
15+
16+
.. automodule:: runloop_api_client.sdk.execution_result
17+
:members:

‎docs/api/gateway_config.rst‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Gateway Config
2+
==============
3+
4+
The ``GatewayConfig`` class manages API gateway configurations that proxy
5+
requests through devboxes with credential management and authentication.
6+
7+
Asynchronous API
8+
----------------
9+
10+
.. automodule:: runloop_api_client.sdk.async_gateway_config
11+
:members:
12+
13+
Synchronous API
14+
---------------
15+
16+
.. automodule:: runloop_api_client.sdk.gateway_config
17+
:members:

0 commit comments

Comments
 (0)