Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
135 changes: 0 additions & 135 deletions docs/api/index.rst

This file was deleted.

11 changes: 0 additions & 11 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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"
Expand All @@ -60,5 +50,4 @@
# Intersphinx mapping
intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"httpx": ("https://www.python-httpx.org", None),
}
6 changes: 3 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ and asynchronous variants to match your runtime requirements.
:maxdepth: 2
:caption: Contents:

api/index
sdk/index

Installation
------------
Expand Down Expand Up @@ -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
Expand Down
8 changes: 8 additions & 0 deletions docs/sdk/async/blueprint.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Blueprint
=========

The ``AsyncBlueprint`` class provides asynchronous methods for managing devbox blueprints.

.. automodule:: runloop_api_client.sdk.async_blueprint
:members:

8 changes: 8 additions & 0 deletions docs/sdk/async/devbox.rst
Original file line number Diff line number Diff line change
@@ -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:

8 changes: 8 additions & 0 deletions docs/sdk/async/execution.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Execution
=========

The ``AsyncExecution`` class represents an asynchronous command execution in progress.

.. automodule:: runloop_api_client.sdk.async_execution
:members:

8 changes: 8 additions & 0 deletions docs/sdk/async/execution_result.rst
Original file line number Diff line number Diff line change
@@ -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:

29 changes: 29 additions & 0 deletions docs/sdk/async/index.rst
Original file line number Diff line number Diff line change
@@ -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

8 changes: 8 additions & 0 deletions docs/sdk/async/snapshot.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Snapshot
========

The ``AsyncSnapshot`` class provides asynchronous methods for managing devbox snapshots.

.. automodule:: runloop_api_client.sdk.async_snapshot
:members:

8 changes: 8 additions & 0 deletions docs/sdk/async/storage_object.rst
Original file line number Diff line number Diff line change
@@ -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:

14 changes: 14 additions & 0 deletions docs/sdk/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
SDK Reference
=============

This section contains detailed documentation for the Runloop SDK.

The Runloop SDK provides both synchronous and asynchronous interfaces for managing devboxes, blueprints, snapshots, and storage objects. Choose the variant that matches your application's runtime requirements.

.. toctree::
:maxdepth: 2
:caption: SDK Documentation

sync/index
async/index
types
8 changes: 8 additions & 0 deletions docs/sdk/sync/blueprint.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Blueprint
=========

The ``Blueprint`` class provides synchronous methods for managing devbox blueprints.

.. automodule:: runloop_api_client.sdk.blueprint
:members:

8 changes: 8 additions & 0 deletions docs/sdk/sync/devbox.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Devbox
======

The ``Devbox`` class provides synchronous methods for managing and interacting with a devbox instance.

.. automodule:: runloop_api_client.sdk.devbox
:members:

8 changes: 8 additions & 0 deletions docs/sdk/sync/execution.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Execution
=========

The ``Execution`` class represents an asynchronous command execution in progress.

.. automodule:: runloop_api_client.sdk.execution
:members:

8 changes: 8 additions & 0 deletions docs/sdk/sync/execution_result.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Execution Result
================

The ``ExecutionResult`` class represents the result of a completed command execution.

.. automodule:: runloop_api_client.sdk.execution_result
:members:

29 changes: 29 additions & 0 deletions docs/sdk/sync/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
Synchronous SDK
===============

The synchronous SDK provides a blocking interface for managing devboxes, blueprints, snapshots, and storage objects. Use this variant when working in synchronous Python code.

Core Module
-----------

The core synchronous SDK module provides the main entry point and operation classes.

.. autoclass:: runloop_api_client.sdk.sync.RunloopSDK

.. automodule:: runloop_api_client.sdk.sync

Resource Modules
----------------

Synchronous resource classes for working with devboxes, blueprints, snapshots, and more.

.. toctree::
:maxdepth: 1

devbox
execution
execution_result
blueprint
snapshot
storage_object

8 changes: 8 additions & 0 deletions docs/sdk/sync/snapshot.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Snapshot
========

The ``Snapshot`` class provides synchronous methods for managing devbox snapshots.

.. automodule:: runloop_api_client.sdk.snapshot
:members:

8 changes: 8 additions & 0 deletions docs/sdk/sync/storage_object.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Storage Object
==============

The ``StorageObject`` class provides synchronous methods for managing storage objects.

.. automodule:: runloop_api_client.sdk.storage_object
:members:

Loading