Skip to content

Commit a62491d

Browse files
committed
don't document inheritance and undocumented members, and separate sync and async documentation into separate pages
1 parent c5663e6 commit a62491d

4 files changed

Lines changed: 63 additions & 99 deletions

File tree

docs/conf.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,6 @@
5050
# Autodoc settings
5151
autodoc_default_options = {
5252
"members": None,
53-
"undoc-members": None,
54-
"show-inheritance": None,
5553
}
5654

5755
autodoc_typehints = "description"

docs/sdk/async.rst

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
Asynchronous SDK
2+
================
3+
4+
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.
5+
6+
Core Module
7+
-----------
8+
9+
The core asynchronous SDK module provides async operation classes.
10+
11+
.. automodule:: runloop_api_client.sdk.async_
12+
13+
Resource Modules
14+
----------------
15+
16+
Asynchronous resource classes for working with devboxes, blueprints, snapshots, and more.
17+
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
27+
28+
.. automodule:: runloop_api_client.sdk.async_execution_result
29+

docs/sdk/index.rst

Lines changed: 5 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -3,104 +3,12 @@ SDK Reference
33

44
This section contains detailed documentation for the Runloop SDK.
55

6+
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.
7+
68
.. toctree::
79
:maxdepth: 2
10+
:caption: SDK Documentation
811

12+
sync
13+
async
914
types
10-
11-
Synchronous SDK
12-
---------------
13-
14-
Core Module
15-
~~~~~~~~~~~
16-
17-
The core synchronous SDK module provides the main entry point and operation classes.
18-
19-
.. automodule:: runloop_api_client.sdk.sync
20-
:members:
21-
:undoc-members:
22-
:show-inheritance:
23-
24-
Resource Modules
25-
~~~~~~~~~~~~~~~~
26-
27-
Synchronous resource classes for working with devboxes, blueprints, snapshots, and more.
28-
29-
.. automodule:: runloop_api_client.sdk.devbox
30-
:members:
31-
:undoc-members:
32-
:show-inheritance:
33-
34-
.. automodule:: runloop_api_client.sdk.blueprint
35-
:members:
36-
:undoc-members:
37-
:show-inheritance:
38-
39-
.. automodule:: runloop_api_client.sdk.snapshot
40-
:members:
41-
:undoc-members:
42-
:show-inheritance:
43-
44-
.. automodule:: runloop_api_client.sdk.storage_object
45-
:members:
46-
:undoc-members:
47-
:show-inheritance:
48-
49-
.. automodule:: runloop_api_client.sdk.execution
50-
:members:
51-
:undoc-members:
52-
:show-inheritance:
53-
54-
.. automodule:: runloop_api_client.sdk.execution_result
55-
:members:
56-
:undoc-members:
57-
:show-inheritance:
58-
59-
Asynchronous SDK
60-
----------------
61-
62-
Core Module
63-
~~~~~~~~~~~
64-
65-
The core asynchronous SDK module provides async operation classes.
66-
67-
.. automodule:: runloop_api_client.sdk.async_
68-
:members:
69-
:undoc-members:
70-
:show-inheritance:
71-
72-
Resource Modules
73-
~~~~~~~~~~~~~~~~
74-
75-
Asynchronous resource classes for working with devboxes, blueprints, snapshots, and more.
76-
77-
.. automodule:: runloop_api_client.sdk.async_devbox
78-
:members:
79-
:undoc-members:
80-
:show-inheritance:
81-
82-
.. automodule:: runloop_api_client.sdk.async_blueprint
83-
:members:
84-
:undoc-members:
85-
:show-inheritance:
86-
87-
.. automodule:: runloop_api_client.sdk.async_snapshot
88-
:members:
89-
:undoc-members:
90-
:show-inheritance:
91-
92-
.. automodule:: runloop_api_client.sdk.async_storage_object
93-
:members:
94-
:undoc-members:
95-
:show-inheritance:
96-
97-
.. automodule:: runloop_api_client.sdk.async_execution
98-
:members:
99-
:undoc-members:
100-
:show-inheritance:
101-
102-
.. automodule:: runloop_api_client.sdk.async_execution_result
103-
:members:
104-
:undoc-members:
105-
:show-inheritance:
106-

docs/sdk/sync.rst

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
Synchronous SDK
2+
===============
3+
4+
The synchronous SDK provides a blocking interface for managing devboxes, blueprints, snapshots, and storage objects. Use this variant when working in synchronous Python code.
5+
6+
Core Module
7+
-----------
8+
9+
The core synchronous SDK module provides the main entry point and operation classes.
10+
11+
.. automodule:: runloop_api_client.sdk.sync
12+
13+
Resource Modules
14+
----------------
15+
16+
Synchronous resource classes for working with devboxes, blueprints, snapshots, and more.
17+
18+
.. automodule:: runloop_api_client.sdk.devbox
19+
20+
.. automodule:: runloop_api_client.sdk.blueprint
21+
22+
.. automodule:: runloop_api_client.sdk.snapshot
23+
24+
.. automodule:: runloop_api_client.sdk.storage_object
25+
26+
.. automodule:: runloop_api_client.sdk.execution
27+
28+
.. automodule:: runloop_api_client.sdk.execution_result
29+

0 commit comments

Comments
 (0)