fix: Armada exceptions documentation incorrectly rendering

This patch set changes Armada'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-armada.readthedocs.io/en/latest/operations/exceptions/guide-exceptions.html

Change-Id: Id7e6730ff1d57e609e8fc4f636645ea8667bd425
This commit is contained in:
Felipe Monteiro 2018-09-23 11:27:20 -04:00
parent 03b4c0ee2a
commit 6ab741b6e3
10 changed files with 175 additions and 215 deletions

View File

@ -14,29 +14,26 @@
License for the specific language governing permissions and limitations
under the License.
.. list-table:: **Api Exceptions**
:widths: 5 50
:header-rows: 1
* - Exception Name
- Description
* - ApiException
- .. autoexception:: armada.exceptions.api_exceptions.ApiException
:members:
:show-inheritance:
:undoc-members:
* - ClientError
- .. autoexception:: armada.exceptions.api_exceptions.ClientError
:members:
:show-inheritance:
:undoc-members:
* - ClientForbiddenError
- .. autoexception:: armada.exceptions.api_exceptions.ClientForbiddenError
:members:
:show-inheritance:
:undoc-members:
* - ClientUnauthorizedError
- .. autoexception:: armada.exceptions.api_exceptions.ClientUnauthorizedError
:members:
:show-inheritance:
:undoc-members:
API Exceptions
--------------
.. autoexception:: armada.exceptions.api_exceptions.ApiException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: armada.exceptions.api_exceptions.ClientError
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: armada.exceptions.api_exceptions.ClientForbiddenError
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: armada.exceptions.api_exceptions.ClientUnauthorizedError
:members:
:show-inheritance:
:undoc-members:

View File

@ -14,19 +14,15 @@
License for the specific language governing permissions and limitations
under the License.
.. list-table:: **Armada Exceptions**
:widths: 5 50
:header-rows: 1
Armada Exceptions
-----------------
* - Exception Name
- Description
* - ArmadaTimeoutException
- .. autoexception:: armada.exceptions.armada_exceptions.ArmadaTimeoutException
:members:
:show-inheritance:
:undoc-members:
* - ProtectedReleaseException
- .. autoexception:: armada.exceptions.armada_exceptions.ProtectedReleaseException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: armada.exceptions.armada_exceptions.ArmadaTimeoutException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: armada.exceptions.armada_exceptions.ProtectedReleaseException
:members:
:show-inheritance:
:undoc-members:

View File

@ -14,14 +14,10 @@
License for the specific language governing permissions and limitations
under the License.
.. list-table:: **Base Exceptions**
:widths: 5 50
:header-rows: 1
Base Exceptions
---------------
* - Exception Name
- Description
* - ActionForbidden
- .. autoexception:: armada.exceptions.base_exception.ActionForbidden
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: armada.exceptions.base_exception.ActionForbidden
:members:
:show-inheritance:
:undoc-members:

View File

@ -14,34 +14,30 @@
License for the specific language governing permissions and limitations
under the License.
.. list-table:: **Chartbuilder Exceptions**
:widths: 5 50
:header-rows: 1
Chartbuilder Exceptions
-----------------------
* - Exception Name
- Description
* - DependencyException
- .. autoexception:: armada.exceptions.chartbuilder_exceptions.DependencyException
:members:
:show-inheritance:
:undoc-members:
* - FilesLoadException
- .. autoexception:: armada.exceptions.chartbuilder_exceptions.FilesLoadException
:members:
:show-inheritance:
:undoc-members:
* - HelmChartBuildException
- .. autoexception:: armada.exceptions.chartbuilder_exceptions.HelmChartBuildException
:members:
:show-inheritance:
:undoc-members:
* - IgnoredFilesLoadException
- .. autoexception:: armada.exceptions.chartbuilder_exceptions.IgnoredFilesLoadException
:members:
:show-inheritance:
:undoc-members:
* - MetadataLoadException
- .. autoexception:: armada.exceptions.chartbuilder_exceptions.MetadataLoadException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: armada.exceptions.chartbuilder_exceptions.DependencyException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: armada.exceptions.chartbuilder_exceptions.FilesLoadException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: armada.exceptions.chartbuilder_exceptions.HelmChartBuildException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: armada.exceptions.chartbuilder_exceptions.IgnoredFilesLoadException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: armada.exceptions.chartbuilder_exceptions.MetadataLoadException
:members:
:show-inheritance:
:undoc-members:

View File

@ -14,25 +14,20 @@
License for the specific language governing permissions and limitations
under the License.
Kubernetes Exceptions
---------------------
.. list-table:: **Kubernetes Exceptions**
:widths: 5 50
:header-rows: 1
.. autoexception:: armada.exceptions.k8s_exceptions.KubernetesErrorEventException
:members:
:show-inheritance:
:undoc-members:
* - Exception Name
- Description
* - KubernetesErrorEventException
- .. autoexception:: armada.exceptions.k8s_exceptions.KubernetesErrorEventException
:members:
:show-inheritance:
:undoc-members:
* - KubernetesUnknownStreamingEventTypeException
- .. autoexception:: armada.exceptions.k8s_exceptions.KubernetesUnknownStreamingEventTypeException
:members:
:show-inheritance:
:undoc-members:
* - KubernetesWatchTimeoutException
- .. autoexception:: armada.exceptions.k8s_exceptions.KubernetesWatchTimeoutException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: armada.exceptions.k8s_exceptions.KubernetesUnknownStreamingEventTypeException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: armada.exceptions.k8s_exceptions.KubernetesWatchTimeoutException
:members:
:show-inheritance:
:undoc-members:

View File

@ -14,14 +14,10 @@
License for the specific language governing permissions and limitations
under the License.
.. list-table:: **Manifest Exceptions**
:widths: 5 50
:header-rows: 1
Manifest Exceptions
-------------------
* - Exception Name
- Description
* - ManifestException
- .. autoexception:: armada.exceptions.manifest_exceptions.ManifestException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: armada.exceptions.manifest_exceptions.ManifestException
:members:
:show-inheritance:
:undoc-members:

View File

@ -14,24 +14,20 @@
License for the specific language governing permissions and limitations
under the License.
.. list-table:: **Override Exceptions**
:widths: 5 50
:header-rows: 1
Override Exceptions
-------------------
* - Exception Name
- Description
* - InvalidOverrideFileException
- .. autoexception:: armada.exceptions.override_exceptions.InvalidOverrideFileException
:members:
:show-inheritance:
:undoc-members:
* - InvalidOverrideValueException
- .. autoexception:: armada.exceptions.override_exceptions.InvalidOverrideValueException
:members:
:show-inheritance:
:undoc-members:
* - UnknownDocumentOverrideException
- .. autoexception:: armada.exceptions.override_exceptions.UnknownDocumentOverrideException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: armada.exceptions.override_exceptions.InvalidOverrideFileException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: armada.exceptions.override_exceptions.InvalidOverrideValueException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: armada.exceptions.override_exceptions.UnknownDocumentOverrideException
:members:
:show-inheritance:
:undoc-members:

View File

@ -14,34 +14,30 @@
License for the specific language governing permissions and limitations
under the License.
.. list-table:: **Source Exceptions**
:widths: 5 50
:header-rows: 1
Source Exceptions
-----------------
* - Exception Name
- Description
* - ChartSourceException
- .. autoexception:: armada.exceptions.source_exceptions.ChartSourceException
:members:
:show-inheritance:
:undoc-members:
* - GitException
- .. autoexception:: armada.exceptions.source_exceptions.GitException
:members:
:show-inheritance:
:undoc-members:
* - InvalidPathException
- .. autoexception:: armada.exceptions.source_exceptions.InvalidPathException
:members:
:show-inheritance:
:undoc-members:
* - TarballDownloadException
- .. autoexception:: armada.exceptions.source_exceptions.TarballDownloadException
:members:
:show-inheritance:
:undoc-members:
* - TarballExtractException
- .. autoexception:: armada.exceptions.source_exceptions.TarballExtractException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: armada.exceptions.source_exceptions.ChartSourceException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: armada.exceptions.source_exceptions.GitException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: armada.exceptions.source_exceptions.InvalidPathException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: armada.exceptions.source_exceptions.TarballDownloadException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: armada.exceptions.source_exceptions.TarballExtractException
:members:
:show-inheritance:
:undoc-members:

View File

@ -14,34 +14,30 @@
License for the specific language governing permissions and limitations
under the License.
.. list-table:: **Tiller Exceptions**
:widths: 5 50
:header-rows: 1
Tiller Exceptions
-----------------
* - Exception Name
- Description
* - ChannelException
- .. autoexception:: armada.exceptions.tiller_exceptions.ChannelException
:members:
:show-inheritance:
:undoc-members:
* - GetReleaseStatusException
- .. autoexception:: armada.exceptions.tiller_exceptions.GetReleaseStatusException
:members:
:show-inheritance:
:undoc-members:
* - PostUpdateJobCreateException
- .. autoexception:: armada.exceptions.tiller_exceptions.PostUpdateJobCreateException
:members:
:show-inheritance:
:undoc-members:
* - PreUpdateJobDeleteException
- .. autoexception:: armada.exceptions.tiller_exceptions.PreUpdateJobDeleteException
:members:
:show-inheritance:
:undoc-members:
* - ReleaseException
- .. autoexception:: armada.exceptions.tiller_exceptions.ReleaseException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: armada.exceptions.tiller_exceptions.ChannelException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: armada.exceptions.tiller_exceptions.GetReleaseStatusException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: armada.exceptions.tiller_exceptions.PostUpdateJobCreateException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: armada.exceptions.tiller_exceptions.PreUpdateJobDeleteException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: armada.exceptions.tiller_exceptions.ReleaseException
:members:
:show-inheritance:
:undoc-members:

View File

@ -14,29 +14,25 @@
License for the specific language governing permissions and limitations
under the License.
.. list-table:: **Lint Exceptions**
:widths: 5 50
:header-rows: 1
Lint (Validate) Exceptions
--------------------------
* - Exception Name
- Description
* - InvalidManifestException
- .. autoexception:: armada.exceptions.validate_exceptions.InvalidManifestException
:members:
:show-inheritance:
:undoc-members:
* - InvalidChartDefinitionException
- .. autoexception:: armada.exceptions.validate_exceptions.InvalidChartDefinitionException
:members:
:show-inheritance:
:undoc-members:
* - InvalidReleaseException
- .. autoexception:: armada.exceptions.validate_exceptions.InvalidReleaseException
:members:
:show-inheritance:
:undoc-members:
* - InvalidArmadaObjectException
- .. autoexception:: armada.exceptions.validate_exceptions.InvalidArmadaObjectException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: armada.exceptions.validate_exceptions.InvalidManifestException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: armada.exceptions.validate_exceptions.InvalidChartDefinitionException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: armada.exceptions.validate_exceptions.InvalidReleaseException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: armada.exceptions.validate_exceptions.InvalidArmadaObjectException
:members:
:show-inheritance:
:undoc-members: