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
Binary file added docs/_static/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 2 additions & 14 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,24 +35,12 @@
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = "furo"
# html_static_path = ["_static"]
html_static_path = ["_static"]
html_favicon = "_static/favicon.png"

# Furo theme options
html_theme_options = {
"navigation_with_keys": True,
"sidebar_hide_name": False,
}

# Show the global toctree in sidebar
html_sidebars = {
"**": [
"sidebar/scroll-start.html",
"sidebar/brand.html",
"sidebar/search.html",
"sidebar/navigation.html",
"sidebar/ethical-ads.html",
"sidebar/scroll-end.html",
]
}

# -- Extension configuration -------------------------------------------------
Expand Down
6 changes: 4 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,12 @@ devboxes, blueprints, snapshots, and storage objects. The SDK offers both synchr
and asynchronous variants to match your runtime requirements.

.. toctree::
:maxdepth: 2
:maxdepth: 1
:caption: Contents:

sdk/index
sdk/async/index
sdk/sync/index
sdk/types

Installation
------------
Expand Down
8 changes: 8 additions & 0 deletions docs/sdk/async/core.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Core Module
===========

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

.. autoclass:: runloop_api_client.sdk.async_.AsyncRunloopSDK

.. automodule:: runloop_api_client.sdk.async_
17 changes: 2 additions & 15 deletions docs/sdk/async/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,10 @@ 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
:maxdepth: 2

core
devbox
execution
execution_result
Expand Down
14 changes: 0 additions & 14 deletions docs/sdk/index.rst

This file was deleted.

8 changes: 8 additions & 0 deletions docs/sdk/sync/core.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
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
17 changes: 2 additions & 15 deletions docs/sdk/sync/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,10 @@ 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
:maxdepth: 2

core
devbox
execution
execution_result
Expand Down
188 changes: 94 additions & 94 deletions uv.lock

Large diffs are not rendered by default.