Skip to content

docs: remove unnecessary protocols.py to clean up docs, adjusted doc order to sort by source declaration order (except in base api type reference) #690

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jrvb-rl merged 1 commit into from
Nov 22, 2025
Merged

docs: remove unnecessary protocols.py to clean up docs, adjusted doc order to sort by source declaration order (except in base api type reference) #690

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
# Autodoc settings
autodoc_default_options = {
"members": None,
"member-order": "bysource",
}

autodoc_typehints = "description"
Expand Down
6 changes: 1 addition & 5 deletions docs/sdk/async/devbox.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,4 @@ Devbox
The ``AsyncDevbox`` class provides asynchronous methods for managing and interacting with a devbox instance.

.. automodule:: runloop_api_client.sdk.async_devbox
:members:

.. automodule:: runloop_api_client.sdk.protocols
:members: AsyncCommandInterface, AsyncFileInterface, AsyncNetworkInterface
:undoc-members:
:members:
6 changes: 1 addition & 5 deletions docs/sdk/sync/devbox.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,4 @@ Devbox
The ``Devbox`` class provides synchronous methods for managing and interacting with a devbox instance.

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

.. automodule:: runloop_api_client.sdk.protocols
:members: CommandInterface, FileInterface, NetworkInterface
:undoc-members:
:members:
4 changes: 3 additions & 1 deletion docs/sdk/types.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,10 @@ Base API Type Reference
:members:
:undoc-members:
:imported-members:
:member-order: groupwise

.. automodule:: runloop_api_client.types
:members:
:undoc-members:
:imported-members:
:imported-members:
:member-order: groupwise
13 changes: 6 additions & 7 deletions src/runloop_api_client/sdk/async_devbox.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@
)
from .._client import AsyncRunloop
from ._helpers import filter_params
from .protocols import AsyncFileInterface, AsyncCommandInterface, AsyncNetworkInterface
from .._streaming import AsyncStream
from ..lib.polling import PollingConfig
from .async_execution import AsyncExecution, _AsyncStreamingGroup
Expand Down Expand Up @@ -259,7 +258,7 @@ def cmd(self) -> AsyncCommandInterface:
:return: Helper for running shell commands
:rtype: AsyncCommandInterface
"""
return _AsyncCommandInterface(self)
return AsyncCommandInterface(self)

@property
def file(self) -> AsyncFileInterface:
Expand All @@ -268,7 +267,7 @@ def file(self) -> AsyncFileInterface:
:return: Helper for reading/writing files
:rtype: AsyncFileInterface
"""
return _AsyncFileInterface(self)
return AsyncFileInterface(self)

@property
def net(self) -> AsyncNetworkInterface:
Expand All @@ -277,7 +276,7 @@ def net(self) -> AsyncNetworkInterface:
:return: Helper for SSH keys and tunnels
:rtype: AsyncNetworkInterface
"""
return _AsyncNetworkInterface(self)
return AsyncNetworkInterface(self)

# ------------------------------------------------------------------ #
# Internal helpers
Expand Down Expand Up @@ -357,7 +356,7 @@ async def _stream_worker(
logger.exception("error streaming %s logs for devbox %s", name, self._id)


class _AsyncCommandInterface:
class AsyncCommandInterface:
"""Interface for executing commands on a devbox.

Accessed via devbox.cmd property. Provides exec() for synchronous execution
Expand Down Expand Up @@ -457,7 +456,7 @@ async def exec_async(
return AsyncExecution(client, devbox.id, execution, streaming_group)


class _AsyncFileInterface:
class AsyncFileInterface:
"""Interface for file operations on a devbox.

Accessed via devbox.file property. Provides coroutines for reading, writing,
Expand Down Expand Up @@ -547,7 +546,7 @@ async def upload(
)


class _AsyncNetworkInterface:
class AsyncNetworkInterface:
"""Interface for networking operations on a devbox.

Accessed via devbox.net property. Provides coroutines for SSH access and tunneling.
Expand Down
13 changes: 6 additions & 7 deletions src/runloop_api_client/sdk/devbox.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@
from .._client import Runloop
from ._helpers import filter_params
from .execution import Execution, _StreamingGroup
from .protocols import FileInterface, CommandInterface, NetworkInterface
from .._streaming import Stream
from ..lib.polling import PollingConfig
from .execution_result import ExecutionResult
Expand Down Expand Up @@ -261,7 +260,7 @@ def cmd(self) -> CommandInterface:
:return: Helper for running shell commands
:rtype: CommandInterface
"""
return _CommandInterface(self)
return CommandInterface(self)

@property
def file(self) -> FileInterface:
Expand All @@ -270,7 +269,7 @@ def file(self) -> FileInterface:
:return: Helper for reading/writing files
:rtype: FileInterface
"""
return _FileInterface(self)
return FileInterface(self)

@property
def net(self) -> NetworkInterface:
Expand All @@ -279,7 +278,7 @@ def net(self) -> NetworkInterface:
:return: Helper for SSH keys and tunnels
:rtype: NetworkInterface
"""
return _NetworkInterface(self)
return NetworkInterface(self)

# --------------------------------------------------------------------- #
# Internal helpers
Expand Down Expand Up @@ -375,7 +374,7 @@ def worker() -> None:
return thread


class _CommandInterface:
class CommandInterface:
"""Interface for executing commands on a devbox.

Accessed via devbox.cmd property. Provides exec() for synchronous execution
Expand Down Expand Up @@ -465,7 +464,7 @@ def exec_async(
return Execution(client, devbox.id, execution, streaming_group)


class _FileInterface:
class FileInterface:
"""Interface for file operations on a devbox.

Accessed via devbox.file property. Provides methods for reading, writing,
Expand Down Expand Up @@ -555,7 +554,7 @@ def upload(
)


class _NetworkInterface:
class NetworkInterface:
"""Interface for network operations on a devbox.

Accessed via devbox.net property. Provides methods for SSH access and tunneling.
Expand Down
201 changes: 0 additions & 201 deletions src/runloop_api_client/sdk/protocols.py
View file
Open in desktop

This file was deleted.

Loading