Merge "fix: Armada exceptions documentation incorrectly rendering"

This commit is contained in:
Zuul 2018-09-27 20:35:38 +00:00 committed by Gerrit Code Review
commit 12b4babe06
10 changed files with 175 additions and 215 deletions

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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