Skip to content
This repository was archived by the owner on Jan 23, 2026. It is now read-only.

Commit 9039c81

Browse files
NickCaogithub-actions[bot]
authored andcommitted
Document exceptions
(cherry picked from commit da20705)
1 parent 32306c1 commit 9039c81

3 files changed

Lines changed: 14 additions & 2 deletions

File tree

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Exceptions
2+
3+
## API Reference
4+
5+
```{eval-rst}
6+
.. automodule:: jumpstarter.common.exceptions
7+
:members:
8+
```

docs/source/reference/package-apis/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ This section provides reference documentation for Jumpstarter's package APIs and
44
components. The documentation covers:
55

66
- [Drivers](drivers/index.md): APIs for various driver categories
7+
- [Exceptions](exceptions.md): Exceptions raised by driver clients
78

89
These references are useful for developers extending Jumpstarter or integrating
910
with custom hardware.
@@ -12,4 +13,5 @@ with custom hardware.
1213
:maxdepth: 1
1314
:hidden:
1415
drivers/index.md
15-
```
16+
exceptions.md
17+
```

packages/jumpstarter/jumpstarter/common/exceptions.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ class JumpstarterException(Exception):
88
class for all jumpstarter-specific errors.
99
It handles the __cause__ attribute so the jumpstarter errors could be raised as
1010
11-
raise SomeError("message") from original_exception
11+
.. code-block:: python
12+
13+
raise SomeError("message") from original_exception
1214
"""
1315

1416
def __init__(self, message: str):

0 commit comments

Comments
 (0)