From 3fb095f0ebf76eb9b7bc222c0decb1ec40896268 Mon Sep 17 00:00:00 2001 From: Felipe Monteiro Date: Sun, 23 Sep 2018 12:27:54 -0400 Subject: [PATCH] fix: Drydock exceptions documentation incorrectly rendering This patch set changes Drydock's exceptions documentation (contained underneath operators guide) because it isn't rendering correctly as a list table on RTD (the autoexception information is missing) [0]. The easy fix is to change the tabularized view (list table) into basically a series of autoexception classes which sufficiently captures the level of detail required, anyway. Note that running `tox -e docs` locally and opening the resulting index.html page appears to work -- but not when hosted on RTD. [0] https://airship-drydock.readthedocs.io/en/latest/exceptions/exceptions.html Change-Id: Ie4bc01f1fe6aee9b9a58fd956f5b350df44bef51 --- docs/source/exceptions/api_error.inc | 23 +++----- docs/source/exceptions/bootaction_error.inc | 33 +++++------- docs/source/exceptions/build_data_error.inc | 14 ++--- docs/source/exceptions/client_error.inc | 23 +++----- docs/source/exceptions/design_error.inc | 33 +++++------- docs/source/exceptions/driver_error.inc | 53 ++++++++----------- docs/source/exceptions/orchestrator_error.inc | 23 +++----- 7 files changed, 77 insertions(+), 125 deletions(-) diff --git a/docs/source/exceptions/api_error.inc b/docs/source/exceptions/api_error.inc index 35f965ad..b49ba5ca 100644 --- a/docs/source/exceptions/api_error.inc +++ b/docs/source/exceptions/api_error.inc @@ -17,19 +17,12 @@ API Errors ---------- -.. list-table:: - :widths: 5 50 - :header-rows: 1 +.. autoexception:: drydock_provisioner.error.ClientError + :members: + :show-inheritance: + :undoc-members: - * - Exception Name - - Description - * - ClientError - - .. autoexception:: drydock_provisioner.error.ClientError - :members: - :show-inheritance: - :undoc-members: - * - InvalidFormat - - .. autoexception:: drydock_provisioner.error.InvalidFormat - :members: - :show-inheritance: - :undoc-members: +.. autoexception:: drydock_provisioner.error.InvalidFormat + :members: + :show-inheritance: + :undoc-members: diff --git a/docs/source/exceptions/bootaction_error.inc b/docs/source/exceptions/bootaction_error.inc index 0ebefe18..ddb1796f 100644 --- a/docs/source/exceptions/bootaction_error.inc +++ b/docs/source/exceptions/bootaction_error.inc @@ -18,24 +18,17 @@ Bootaction Errors ----------------- -.. list-table:: - :widths: 5 50 - :header-rows: 1 +.. autoexception:: drydock_provisioner.error.InvalidAssetLocation + :members: + :show-inheritance: + :undoc-members: - * - Exception Name - - Description - * - InvalidAssetLocation - - .. autoexception:: drydock_provisioner.error.InvalidAssetLocation - :members: - :show-inheritance: - :undoc-members: - * - PipelineFailure - - .. autoexception:: drydock_provisioner.error.PipelineFailure - :members: - :show-inheritance: - :undoc-members: - * - UnknownPipelineSegment - - .. autoexception:: drydock_provisioner.error.UnknownPipelineSegment - :members: - :show-inheritance: - :undoc-members: +.. autoexception:: drydock_provisioner.error.PipelineFailure + :members: + :show-inheritance: + :undoc-members: + +.. autoexception:: drydock_provisioner.error.UnknownPipelineSegment + :members: + :show-inheritance: + :undoc-members: diff --git a/docs/source/exceptions/build_data_error.inc b/docs/source/exceptions/build_data_error.inc index cb757e8d..3fcd3d29 100644 --- a/docs/source/exceptions/build_data_error.inc +++ b/docs/source/exceptions/build_data_error.inc @@ -17,14 +17,8 @@ BuildData Errors ---------------- -.. list-table:: - :widths: 5 50 - :header-rows: 1 - * - Exception Name - - Description - * - BuildDataError - - .. autoexception:: drydock_provisioner.error.BuildDataError - :members: - :show-inheritance: - :undoc-members: +.. autoexception:: drydock_provisioner.error.BuildDataError + :members: + :show-inheritance: + :undoc-members: diff --git a/docs/source/exceptions/client_error.inc b/docs/source/exceptions/client_error.inc index 6f316500..989143e0 100644 --- a/docs/source/exceptions/client_error.inc +++ b/docs/source/exceptions/client_error.inc @@ -17,19 +17,12 @@ Client Errors ------------- -.. list-table:: - :widths: 5 50 - :header-rows: 1 +.. autoexception:: drydock_provisioner.error.ClientForbiddenError + :members: + :show-inheritance: + :undoc-members: - * - Exception Name - - Description - * - ClientForbiddenError - - .. autoexception:: drydock_provisioner.error.ClientForbiddenError - :members: - :show-inheritance: - :undoc-members: - * - ClientUnauthorizedError - - .. autoexception:: drydock_provisioner.error.ClientUnauthorizedError - :members: - :show-inheritance: - :undoc-members: +.. autoexception:: drydock_provisioner.error.ClientUnauthorizedError + :members: + :show-inheritance: + :undoc-members: diff --git a/docs/source/exceptions/design_error.inc b/docs/source/exceptions/design_error.inc index 45031a54..20c2048b 100644 --- a/docs/source/exceptions/design_error.inc +++ b/docs/source/exceptions/design_error.inc @@ -17,24 +17,17 @@ Design Errors ------------- -.. list-table:: - :widths: 5 50 - :header-rows: 1 +.. autoexception:: drydock_provisioner.error.DesignError + :members: + :show-inheritance: + :undoc-members: - * - Exception Name - - Description - * - DesignError - - .. autoexception:: drydock_provisioner.error.DesignError - :members: - :show-inheritance: - :undoc-members: - * - IngesterError - - .. autoexception:: drydock_provisioner.error.IngesterError - :members: - :show-inheritance: - :undoc-members: - * - InvalidDesignReference - - .. autoexception:: drydock_provisioner.error.InvalidDesignReference - :members: - :show-inheritance: - :undoc-members: +.. autoexception:: drydock_provisioner.error.IngesterError + :members: + :show-inheritance: + :undoc-members: + +.. autoexception:: drydock_provisioner.error.InvalidDesignReference + :members: + :show-inheritance: + :undoc-members: diff --git a/docs/source/exceptions/driver_error.inc b/docs/source/exceptions/driver_error.inc index 0e90a691..82a49908 100644 --- a/docs/source/exceptions/driver_error.inc +++ b/docs/source/exceptions/driver_error.inc @@ -17,34 +17,27 @@ Driver Errors ------------- -.. list-table:: - :widths: 5 50 - :header-rows: 1 +.. autoexception:: drydock_provisioner.error.DriverError + :members: + :show-inheritance: + :undoc-members: - * - Exception Name - - Description - * - DriverError - - .. autoexception:: drydock_provisioner.error.DriverError - :members: - :show-inheritance: - :undoc-members: - * - InvalidSizeFormat - - .. autoexception:: drydock_provisioner.error.InvalidSizeFormat - :members: - :show-inheritance: - :undoc-members: - * - NotEnoughStorage - - .. autoexception:: drydock_provisioner.error.NotEnoughStorage - :members: - :show-inheritance: - :undoc-members: - * - PersistentDriverError - - .. autoexception:: drydock_provisioner.error.PersistentDriverError - :members: - :show-inheritance: - :undoc-members: - * - TransientDriverError - - .. autoexception:: drydock_provisioner.error.TransientDriverError - :members: - :show-inheritance: - :undoc-members: +.. autoexception:: drydock_provisioner.error.InvalidSizeFormat + :members: + :show-inheritance: + :undoc-members: + +.. autoexception:: drydock_provisioner.error.NotEnoughStorage + :members: + :show-inheritance: + :undoc-members: + +.. autoexception:: drydock_provisioner.error.PersistentDriverError + :members: + :show-inheritance: + :undoc-members: + +.. autoexception:: drydock_provisioner.error.TransientDriverError + :members: + :show-inheritance: + :undoc-members: diff --git a/docs/source/exceptions/orchestrator_error.inc b/docs/source/exceptions/orchestrator_error.inc index c8695395..8120faf4 100644 --- a/docs/source/exceptions/orchestrator_error.inc +++ b/docs/source/exceptions/orchestrator_error.inc @@ -18,19 +18,12 @@ Orchestrator Errors ------------------- -.. list-table:: - :widths: 5 50 - :header-rows: 1 +.. autoexception:: drydock_provisioner.error.MaxRetriesReached + :members: + :show-inheritance: + :undoc-members: - * - Exception Name - - Description - * - MaxRetriesReached - - .. autoexception:: drydock_provisioner.error.MaxRetriesReached - :members: - :show-inheritance: - :undoc-members: - * - OrchestratorError - - .. autoexception:: drydock_provisioner.error.OrchestratorError - :members: - :show-inheritance: - :undoc-members: +.. autoexception:: drydock_provisioner.error.OrchestratorError + :members: + :show-inheritance: + :undoc-members: