Skip to content

Commit 704f053

Browse files
committed
restructuring to give each resource a separate page
1 parent 5139eca commit 704f053

File tree

15 files changed

+118
-22
lines changed

15 files changed

+118
-22
lines changed

docs/sdk/async/blueprint.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Blueprint
2+
=========
3+
4+
The ``AsyncBlueprint`` class provides asynchronous methods for managing devbox blueprints.
5+
6+
.. automodule:: runloop_api_client.sdk.async_blueprint
7+
:members:
8+

docs/sdk/async/devbox.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Devbox
2+
======
3+
4+
The ``AsyncDevbox`` class provides asynchronous methods for managing and interacting with a devbox instance.
5+
6+
.. automodule:: runloop_api_client.sdk.async_devbox
7+
:members:
8+

docs/sdk/async/execution.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Execution
2+
=========
3+
4+
The ``AsyncExecution`` class represents an asynchronous command execution in progress.
5+
6+
.. automodule:: runloop_api_client.sdk.async_execution
7+
:members:
8+
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Execution Result
2+
================
3+
4+
The ``AsyncExecutionResult`` class represents the result of a completed command execution.
5+
6+
.. automodule:: runloop_api_client.sdk.async_execution_result
7+
:members:
8+
Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,22 @@ Core Module
88

99
The core asynchronous SDK module provides async operation classes.
1010

11+
.. autoclass:: runloop_api_client.sdk.async_.AsyncRunloopSDK
12+
1113
.. automodule:: runloop_api_client.sdk.async_
1214

1315
Resource Modules
1416
----------------
1517

1618
Asynchronous resource classes for working with devboxes, blueprints, snapshots, and more.
1719

18-
.. automodule:: runloop_api_client.sdk.async_devbox
19-
20-
.. automodule:: runloop_api_client.sdk.async_blueprint
21-
22-
.. automodule:: runloop_api_client.sdk.async_snapshot
23-
24-
.. automodule:: runloop_api_client.sdk.async_storage_object
25-
26-
.. automodule:: runloop_api_client.sdk.async_execution
20+
.. toctree::
21+
:maxdepth: 1
2722

28-
.. automodule:: runloop_api_client.sdk.async_execution_result
23+
devbox
24+
execution
25+
execution_result
26+
blueprint
27+
snapshot
28+
storage_object
2929

docs/sdk/async/snapshot.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Snapshot
2+
========
3+
4+
The ``AsyncSnapshot`` class provides asynchronous methods for managing devbox snapshots.
5+
6+
.. automodule:: runloop_api_client.sdk.async_snapshot
7+
:members:
8+

docs/sdk/async/storage_object.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Storage Object
2+
==============
3+
4+
The ``AsyncStorageObject`` class provides asynchronous methods for managing storage objects.
5+
6+
.. automodule:: runloop_api_client.sdk.async_storage_object
7+
:members:
8+

docs/sdk/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@ The Runloop SDK provides both synchronous and asynchronous interfaces for managi
99
:maxdepth: 2
1010
:caption: SDK Documentation
1111

12-
sync
13-
async
12+
sync/index
13+
async/index
1414
types

docs/sdk/sync/blueprint.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Blueprint
2+
=========
3+
4+
The ``Blueprint`` class provides synchronous methods for managing devbox blueprints.
5+
6+
.. automodule:: runloop_api_client.sdk.blueprint
7+
:members:
8+

docs/sdk/sync/devbox.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Devbox
2+
======
3+
4+
The ``Devbox`` class provides synchronous methods for managing and interacting with a devbox instance.
5+
6+
.. automodule:: runloop_api_client.sdk.devbox
7+
:members:
8+

0 commit comments

Comments
 (0)