airship
/
armada
Code Issues Proposed changes

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
parent beb4739c55 6ab741b6e3
commit 12b4babe06
10 changed files with 175 additions and 215 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
doc/source/operations/exceptions/api-exceptions.inc
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:

26
doc/source/operations/exceptions/armada-exceptions.inc
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 :members:
* - ArmadaTimeoutException :show-inheritance:
- .. autoexception:: armada.exceptions.armada_exceptions.ArmadaTimeoutException :undoc-members:
:members:
:show-inheritance: .. autoexception:: armada.exceptions.armada_exceptions.ProtectedReleaseException
:undoc-members: :members:
* - ProtectedReleaseException :show-inheritance:
- .. autoexception:: armada.exceptions.armada_exceptions.ProtectedReleaseException :undoc-members:
:members:
:show-inheritance:
:undoc-members:

16
doc/source/operations/exceptions/base-exceptions.inc
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 :members:
* - ActionForbidden :show-inheritance:
- .. autoexception:: armada.exceptions.base_exception.ActionForbidden :undoc-members:
:members:
:show-inheritance:
:undoc-members:

56
doc/source/operations/exceptions/chartbuilder-exceptions.inc
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 :members:
* - DependencyException :show-inheritance:
- .. autoexception:: armada.exceptions.chartbuilder_exceptions.DependencyException :undoc-members:
:members:
:show-inheritance: .. autoexception:: armada.exceptions.chartbuilder_exceptions.FilesLoadException
:undoc-members: :members:
* - FilesLoadException :show-inheritance:
- .. autoexception:: armada.exceptions.chartbuilder_exceptions.FilesLoadException :undoc-members:
:members:
:show-inheritance: .. autoexception:: armada.exceptions.chartbuilder_exceptions.HelmChartBuildException
:undoc-members: :members:
* - HelmChartBuildException :show-inheritance:
- .. autoexception:: armada.exceptions.chartbuilder_exceptions.HelmChartBuildException :undoc-members:
:members:
:show-inheritance: .. autoexception:: armada.exceptions.chartbuilder_exceptions.IgnoredFilesLoadException
:undoc-members: :members:
* - IgnoredFilesLoadException :show-inheritance:
- .. autoexception:: armada.exceptions.chartbuilder_exceptions.IgnoredFilesLoadException :undoc-members:
:members:
:show-inheritance: .. autoexception:: armada.exceptions.chartbuilder_exceptions.MetadataLoadException
:undoc-members: :members:
* - MetadataLoadException :show-inheritance:
- .. autoexception:: armada.exceptions.chartbuilder_exceptions.MetadataLoadException :undoc-members:
:members:
:show-inheritance:
:undoc-members:

35
doc/source/operations/exceptions/k8s-exceptions.inc
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 :members:
* - KubernetesErrorEventException :show-inheritance:
- .. autoexception:: armada.exceptions.k8s_exceptions.KubernetesErrorEventException :undoc-members:
:members:
:show-inheritance: .. autoexception:: armada.exceptions.k8s_exceptions.KubernetesWatchTimeoutException
:undoc-members: :members:
* - KubernetesUnknownStreamingEventTypeException :show-inheritance:
- .. autoexception:: armada.exceptions.k8s_exceptions.KubernetesUnknownStreamingEventTypeException :undoc-members:
:members:
:show-inheritance:
:undoc-members:
* - KubernetesWatchTimeoutException
- .. autoexception:: armada.exceptions.k8s_exceptions.KubernetesWatchTimeoutException
:members:
:show-inheritance:
:undoc-members:

16
doc/source/operations/exceptions/manifest-exceptions.inc
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 :members:
* - ManifestException :show-inheritance:
- .. autoexception:: armada.exceptions.manifest_exceptions.ManifestException :undoc-members:
:members:
:show-inheritance:
:undoc-members:

36
doc/source/operations/exceptions/override-exceptions.inc
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 :members:
* - InvalidOverrideFileException :show-inheritance:
- .. autoexception:: armada.exceptions.override_exceptions.InvalidOverrideFileException :undoc-members:
:members:
:show-inheritance: .. autoexception:: armada.exceptions.override_exceptions.InvalidOverrideValueException
:undoc-members: :members:
* - InvalidOverrideValueException :show-inheritance:
- .. autoexception:: armada.exceptions.override_exceptions.InvalidOverrideValueException :undoc-members:
:members:
:show-inheritance: .. autoexception:: armada.exceptions.override_exceptions.UnknownDocumentOverrideException
:undoc-members: :members:
* - UnknownDocumentOverrideException :show-inheritance:
- .. autoexception:: armada.exceptions.override_exceptions.UnknownDocumentOverrideException :undoc-members:
:members:
:show-inheritance:
:undoc-members:

56
doc/source/operations/exceptions/source-exceptions.inc
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 :members:
* - ChartSourceException :show-inheritance:
- .. autoexception:: armada.exceptions.source_exceptions.ChartSourceException :undoc-members:
:members:
:show-inheritance: .. autoexception:: armada.exceptions.source_exceptions.GitException
:undoc-members: :members:
* - GitException :show-inheritance:
- .. autoexception:: armada.exceptions.source_exceptions.GitException :undoc-members:
:members:
:show-inheritance: .. autoexception:: armada.exceptions.source_exceptions.InvalidPathException
:undoc-members: :members:
* - InvalidPathException :show-inheritance:
- .. autoexception:: armada.exceptions.source_exceptions.InvalidPathException :undoc-members:
:members:
:show-inheritance: .. autoexception:: armada.exceptions.source_exceptions.TarballDownloadException
:undoc-members: :members:
* - TarballDownloadException :show-inheritance:
- .. autoexception:: armada.exceptions.source_exceptions.TarballDownloadException :undoc-members:
:members:
:show-inheritance: .. autoexception:: armada.exceptions.source_exceptions.TarballExtractException
:undoc-members: :members:
* - TarballExtractException :show-inheritance:
- .. autoexception:: armada.exceptions.source_exceptions.TarballExtractException :undoc-members:
:members:
:show-inheritance:
:undoc-members:

56
doc/source/operations/exceptions/tiller-exceptions.inc
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 :members:
* - ChannelException :show-inheritance:
- .. autoexception:: armada.exceptions.tiller_exceptions.ChannelException :undoc-members:
:members:
:show-inheritance: .. autoexception:: armada.exceptions.tiller_exceptions.GetReleaseStatusException
:undoc-members: :members:
* - GetReleaseStatusException :show-inheritance:
- .. autoexception:: armada.exceptions.tiller_exceptions.GetReleaseStatusException :undoc-members:
:members:
:show-inheritance: .. autoexception:: armada.exceptions.tiller_exceptions.PostUpdateJobCreateException
:undoc-members: :members:
* - PostUpdateJobCreateException :show-inheritance:
- .. autoexception:: armada.exceptions.tiller_exceptions.PostUpdateJobCreateException :undoc-members:
:members:
:show-inheritance: .. autoexception:: armada.exceptions.tiller_exceptions.PreUpdateJobDeleteException
:undoc-members: :members:
* - PreUpdateJobDeleteException :show-inheritance:
- .. autoexception:: armada.exceptions.tiller_exceptions.PreUpdateJobDeleteException :undoc-members:
:members:
:show-inheritance: .. autoexception:: armada.exceptions.tiller_exceptions.ReleaseException
:undoc-members: :members:
* - ReleaseException :show-inheritance:
- .. autoexception:: armada.exceptions.tiller_exceptions.ReleaseException :undoc-members:
:members:
:show-inheritance:
:undoc-members:

46
doc/source/operations/exceptions/validate-exceptions.inc
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 :members:
* - InvalidManifestException :show-inheritance:
- .. autoexception:: armada.exceptions.validate_exceptions.InvalidManifestException :undoc-members:
:members:
:show-inheritance: .. autoexception:: armada.exceptions.validate_exceptions.InvalidChartDefinitionException
:undoc-members: :members:
* - InvalidChartDefinitionException :show-inheritance:
- .. autoexception:: armada.exceptions.validate_exceptions.InvalidChartDefinitionException :undoc-members:
:members:
:show-inheritance: .. autoexception:: armada.exceptions.validate_exceptions.InvalidReleaseException
:undoc-members: :members:
* - InvalidReleaseException :show-inheritance:
- .. autoexception:: armada.exceptions.validate_exceptions.InvalidReleaseException :undoc-members:
:members:
:show-inheritance: .. autoexception:: armada.exceptions.validate_exceptions.InvalidArmadaObjectException
:undoc-members: :members:
* - InvalidArmadaObjectException :show-inheritance:
- .. autoexception:: armada.exceptions.validate_exceptions.InvalidArmadaObjectException :undoc-members:
:members:
:show-inheritance:
:undoc-members: