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
This commit is contained in:
Felipe Monteiro 2018-09-23 12:27:54 -04:00
parent b1d24ad254
commit 3fb095f0eb
7 changed files with 77 additions and 125 deletions

View File

@ -17,19 +17,12 @@
API Errors API Errors
---------- ----------
.. list-table:: .. autoexception:: drydock_provisioner.error.ClientError
:widths: 5 50 :members:
:header-rows: 1 :show-inheritance:
:undoc-members:
* - Exception Name .. autoexception:: drydock_provisioner.error.InvalidFormat
- Description
* - ClientError
- .. autoexception:: drydock_provisioner.error.ClientError
:members:
:show-inheritance:
:undoc-members:
* - InvalidFormat
- .. autoexception:: drydock_provisioner.error.InvalidFormat
:members: :members:
:show-inheritance: :show-inheritance:
:undoc-members: :undoc-members:

View File

@ -18,24 +18,17 @@
Bootaction Errors Bootaction Errors
----------------- -----------------
.. list-table:: .. autoexception:: drydock_provisioner.error.InvalidAssetLocation
:widths: 5 50 :members:
:header-rows: 1 :show-inheritance:
:undoc-members:
* - Exception Name .. autoexception:: drydock_provisioner.error.PipelineFailure
- Description
* - InvalidAssetLocation
- .. autoexception:: drydock_provisioner.error.InvalidAssetLocation
:members: :members:
:show-inheritance: :show-inheritance:
:undoc-members: :undoc-members:
* - PipelineFailure
- .. autoexception:: drydock_provisioner.error.PipelineFailure .. autoexception:: drydock_provisioner.error.UnknownPipelineSegment
:members:
:show-inheritance:
:undoc-members:
* - UnknownPipelineSegment
- .. autoexception:: drydock_provisioner.error.UnknownPipelineSegment
:members: :members:
:show-inheritance: :show-inheritance:
:undoc-members: :undoc-members:

View File

@ -17,14 +17,8 @@
BuildData Errors BuildData Errors
---------------- ----------------
.. list-table::
:widths: 5 50
:header-rows: 1
* - Exception Name .. autoexception:: drydock_provisioner.error.BuildDataError
- Description
* - BuildDataError
- .. autoexception:: drydock_provisioner.error.BuildDataError
:members: :members:
:show-inheritance: :show-inheritance:
:undoc-members: :undoc-members:

View File

@ -17,19 +17,12 @@
Client Errors Client Errors
------------- -------------
.. list-table:: .. autoexception:: drydock_provisioner.error.ClientForbiddenError
:widths: 5 50 :members:
:header-rows: 1 :show-inheritance:
:undoc-members:
* - Exception Name .. autoexception:: drydock_provisioner.error.ClientUnauthorizedError
- Description
* - ClientForbiddenError
- .. autoexception:: drydock_provisioner.error.ClientForbiddenError
:members:
:show-inheritance:
:undoc-members:
* - ClientUnauthorizedError
- .. autoexception:: drydock_provisioner.error.ClientUnauthorizedError
:members: :members:
:show-inheritance: :show-inheritance:
:undoc-members: :undoc-members:

View File

@ -17,24 +17,17 @@
Design Errors Design Errors
------------- -------------
.. list-table:: .. autoexception:: drydock_provisioner.error.DesignError
:widths: 5 50 :members:
:header-rows: 1 :show-inheritance:
:undoc-members:
* - Exception Name .. autoexception:: drydock_provisioner.error.IngesterError
- Description
* - DesignError
- .. autoexception:: drydock_provisioner.error.DesignError
:members: :members:
:show-inheritance: :show-inheritance:
:undoc-members: :undoc-members:
* - IngesterError
- .. autoexception:: drydock_provisioner.error.IngesterError .. autoexception:: drydock_provisioner.error.InvalidDesignReference
:members:
:show-inheritance:
:undoc-members:
* - InvalidDesignReference
- .. autoexception:: drydock_provisioner.error.InvalidDesignReference
:members: :members:
:show-inheritance: :show-inheritance:
:undoc-members: :undoc-members:

View File

@ -17,34 +17,27 @@
Driver Errors Driver Errors
------------- -------------
.. list-table:: .. autoexception:: drydock_provisioner.error.DriverError
:widths: 5 50 :members:
:header-rows: 1 :show-inheritance:
:undoc-members:
* - Exception Name .. autoexception:: drydock_provisioner.error.InvalidSizeFormat
- Description
* - DriverError
- .. autoexception:: drydock_provisioner.error.DriverError
:members: :members:
:show-inheritance: :show-inheritance:
:undoc-members: :undoc-members:
* - InvalidSizeFormat
- .. autoexception:: drydock_provisioner.error.InvalidSizeFormat .. autoexception:: drydock_provisioner.error.NotEnoughStorage
:members: :members:
:show-inheritance: :show-inheritance:
:undoc-members: :undoc-members:
* - NotEnoughStorage
- .. autoexception:: drydock_provisioner.error.NotEnoughStorage .. autoexception:: drydock_provisioner.error.PersistentDriverError
:members: :members:
:show-inheritance: :show-inheritance:
:undoc-members: :undoc-members:
* - PersistentDriverError
- .. autoexception:: drydock_provisioner.error.PersistentDriverError .. autoexception:: drydock_provisioner.error.TransientDriverError
:members:
:show-inheritance:
:undoc-members:
* - TransientDriverError
- .. autoexception:: drydock_provisioner.error.TransientDriverError
:members: :members:
:show-inheritance: :show-inheritance:
:undoc-members: :undoc-members:

View File

@ -18,19 +18,12 @@
Orchestrator Errors Orchestrator Errors
------------------- -------------------
.. list-table:: .. autoexception:: drydock_provisioner.error.MaxRetriesReached
:widths: 5 50 :members:
:header-rows: 1 :show-inheritance:
:undoc-members:
* - Exception Name .. autoexception:: drydock_provisioner.error.OrchestratorError
- Description
* - MaxRetriesReached
- .. autoexception:: drydock_provisioner.error.MaxRetriesReached
:members:
:show-inheritance:
:undoc-members:
* - OrchestratorError
- .. autoexception:: drydock_provisioner.error.OrchestratorError
:members: :members:
:show-inheritance: :show-inheritance:
:undoc-members: :undoc-members: