Browse Source

Merge "fix: Drydock exceptions documentation incorrectly rendering"

changes/86/584786/4
Zuul 9 months ago
parent
commit
ebb712ff50

+ 8
- 15
docs/source/exceptions/api_error.inc View File

@@ -17,19 +17,12 @@
17 17
 API Errors
18 18
 ----------
19 19
 
20
-.. list-table::
21
-  :widths: 5 50
22
-  :header-rows: 1
20
+.. autoexception:: drydock_provisioner.error.ClientError
21
+   :members:
22
+   :show-inheritance:
23
+   :undoc-members:
23 24
 
24
-  * - Exception Name
25
-    - Description
26
-  * - ClientError
27
-    - .. autoexception:: drydock_provisioner.error.ClientError
28
-         :members:
29
-         :show-inheritance:
30
-         :undoc-members:
31
-  * - InvalidFormat
32
-    - .. autoexception:: drydock_provisioner.error.InvalidFormat
33
-         :members:
34
-         :show-inheritance:
35
-         :undoc-members:
25
+.. autoexception:: drydock_provisioner.error.InvalidFormat
26
+   :members:
27
+   :show-inheritance:
28
+   :undoc-members:

+ 14
- 21
docs/source/exceptions/bootaction_error.inc View File

@@ -18,24 +18,17 @@
18 18
 Bootaction Errors
19 19
 -----------------
20 20
 
21
-.. list-table::
22
-  :widths: 5 50
23
-  :header-rows: 1
24
-
25
-  * - Exception Name
26
-    - Description
27
-  * - InvalidAssetLocation
28
-    - .. autoexception:: drydock_provisioner.error.InvalidAssetLocation
29
-         :members:
30
-         :show-inheritance:
31
-         :undoc-members:
32
-  * - PipelineFailure
33
-    - .. autoexception:: drydock_provisioner.error.PipelineFailure
34
-         :members:
35
-         :show-inheritance:
36
-         :undoc-members:
37
-  * - UnknownPipelineSegment
38
-    - .. autoexception:: drydock_provisioner.error.UnknownPipelineSegment
39
-         :members:
40
-         :show-inheritance:
41
-         :undoc-members:
21
+.. autoexception:: drydock_provisioner.error.InvalidAssetLocation
22
+   :members:
23
+   :show-inheritance:
24
+   :undoc-members:
25
+
26
+.. autoexception:: drydock_provisioner.error.PipelineFailure
27
+   :members:
28
+   :show-inheritance:
29
+   :undoc-members:
30
+
31
+.. autoexception:: drydock_provisioner.error.UnknownPipelineSegment
32
+   :members:
33
+   :show-inheritance:
34
+   :undoc-members:

+ 4
- 10
docs/source/exceptions/build_data_error.inc View File

@@ -17,14 +17,8 @@
17 17
 
18 18
 BuildData Errors
19 19
 ----------------
20
-.. list-table::
21
-  :widths: 5 50
22
-  :header-rows: 1
23 20
 
24
-  * - Exception Name
25
-    - Description
26
-  * - BuildDataError
27
-    - .. autoexception:: drydock_provisioner.error.BuildDataError
28
-         :members:
29
-         :show-inheritance:
30
-         :undoc-members:
21
+.. autoexception:: drydock_provisioner.error.BuildDataError
22
+   :members:
23
+   :show-inheritance:
24
+   :undoc-members:

+ 8
- 15
docs/source/exceptions/client_error.inc View File

@@ -17,19 +17,12 @@
17 17
 Client Errors
18 18
 -------------
19 19
 
20
-.. list-table::
21
-  :widths: 5 50
22
-  :header-rows: 1
20
+.. autoexception:: drydock_provisioner.error.ClientForbiddenError
21
+   :members:
22
+   :show-inheritance:
23
+   :undoc-members:
23 24
 
24
-  * - Exception Name
25
-    - Description
26
-  * - ClientForbiddenError
27
-    - .. autoexception:: drydock_provisioner.error.ClientForbiddenError
28
-         :members:
29
-         :show-inheritance:
30
-         :undoc-members:
31
-  * - ClientUnauthorizedError
32
-    - .. autoexception:: drydock_provisioner.error.ClientUnauthorizedError
33
-         :members:
34
-         :show-inheritance:
35
-         :undoc-members:
25
+.. autoexception:: drydock_provisioner.error.ClientUnauthorizedError
26
+   :members:
27
+   :show-inheritance:
28
+   :undoc-members:

+ 13
- 20
docs/source/exceptions/design_error.inc View File

@@ -17,24 +17,17 @@
17 17
 Design Errors
18 18
 -------------
19 19
 
20
-.. list-table::
21
-  :widths: 5 50
22
-  :header-rows: 1
20
+.. autoexception:: drydock_provisioner.error.DesignError
21
+   :members:
22
+   :show-inheritance:
23
+   :undoc-members:
23 24
 
24
-  * - Exception Name
25
-    - Description
26
-  * - DesignError
27
-    - .. autoexception:: drydock_provisioner.error.DesignError
28
-         :members:
29
-         :show-inheritance:
30
-         :undoc-members:
31
-  * - IngesterError
32
-    - .. autoexception:: drydock_provisioner.error.IngesterError
33
-         :members:
34
-         :show-inheritance:
35
-         :undoc-members:
36
-  * - InvalidDesignReference
37
-    - .. autoexception:: drydock_provisioner.error.InvalidDesignReference
38
-         :members:
39
-         :show-inheritance:
40
-         :undoc-members:
25
+.. autoexception:: drydock_provisioner.error.IngesterError
26
+   :members:
27
+   :show-inheritance:
28
+   :undoc-members:
29
+
30
+.. autoexception:: drydock_provisioner.error.InvalidDesignReference
31
+   :members:
32
+   :show-inheritance:
33
+   :undoc-members:

+ 24
- 31
docs/source/exceptions/driver_error.inc View File

@@ -17,34 +17,27 @@
17 17
 Driver Errors
18 18
 -------------
19 19
 
20
-.. list-table::
21
-  :widths: 5 50
22
-  :header-rows: 1
23
-
24
-  * - Exception Name
25
-    - Description
26
-  * - DriverError
27
-    - .. autoexception:: drydock_provisioner.error.DriverError
28
-         :members:
29
-         :show-inheritance:
30
-         :undoc-members:
31
-  * - InvalidSizeFormat
32
-    - .. autoexception:: drydock_provisioner.error.InvalidSizeFormat
33
-         :members:
34
-         :show-inheritance:
35
-         :undoc-members:
36
-  * - NotEnoughStorage
37
-    - .. autoexception:: drydock_provisioner.error.NotEnoughStorage
38
-         :members:
39
-         :show-inheritance:
40
-         :undoc-members:
41
-  * - PersistentDriverError
42
-    - .. autoexception:: drydock_provisioner.error.PersistentDriverError
43
-         :members:
44
-         :show-inheritance:
45
-         :undoc-members:
46
-  * - TransientDriverError
47
-    - .. autoexception:: drydock_provisioner.error.TransientDriverError
48
-         :members:
49
-         :show-inheritance:
50
-         :undoc-members:
20
+.. autoexception:: drydock_provisioner.error.DriverError
21
+   :members:
22
+   :show-inheritance:
23
+   :undoc-members:
24
+
25
+.. autoexception:: drydock_provisioner.error.InvalidSizeFormat
26
+   :members:
27
+   :show-inheritance:
28
+   :undoc-members:
29
+
30
+.. autoexception:: drydock_provisioner.error.NotEnoughStorage
31
+   :members:
32
+   :show-inheritance:
33
+   :undoc-members:
34
+
35
+.. autoexception:: drydock_provisioner.error.PersistentDriverError
36
+   :members:
37
+   :show-inheritance:
38
+   :undoc-members:
39
+
40
+.. autoexception:: drydock_provisioner.error.TransientDriverError
41
+   :members:
42
+   :show-inheritance:
43
+   :undoc-members:

+ 8
- 15
docs/source/exceptions/orchestrator_error.inc View File

@@ -18,19 +18,12 @@
18 18
 Orchestrator Errors
19 19
 -------------------
20 20
 
21
-.. list-table::
22
-  :widths: 5 50
23
-  :header-rows: 1
21
+.. autoexception:: drydock_provisioner.error.MaxRetriesReached
22
+   :members:
23
+   :show-inheritance:
24
+   :undoc-members:
24 25
 
25
-  * - Exception Name
26
-    - Description
27
-  * - MaxRetriesReached
28
-    - .. autoexception:: drydock_provisioner.error.MaxRetriesReached
29
-         :members:
30
-         :show-inheritance:
31
-         :undoc-members:
32
-  * - OrchestratorError
33
-    - .. autoexception:: drydock_provisioner.error.OrchestratorError
34
-         :members:
35
-         :show-inheritance:
36
-         :undoc-members:
26
+.. autoexception:: drydock_provisioner.error.OrchestratorError
27
+   :members:
28
+   :show-inheritance:
29
+   :undoc-members:

Loading…
Cancel
Save