promenade/doc/source/exceptions.rst
Felipe Monteiro dec7666def fix: Promenade exceptions documentation incorrectly rendering
This patch set changes Promenade'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-promenade.readthedocs.io/en/latest/exceptions.html

Change-Id: Idefb43d230f11194df863f72aea06f7f153313f9
2018-09-23 12:32:51 -04:00

50 lines
1.4 KiB
ReStructuredText

..
Copyright 2017 AT&T Intellectual Property.
All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
Promenade Exceptions
====================
.. autoexception:: promenade.exceptions.ApiError
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: promenade.exceptions.InvalidFormatError
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: promenade.exceptions.ValidationException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: promenade.exceptions.KubernetesConfigException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: promenade.exceptions.KubernetesApiError
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: promenade.exceptions.NodeNotFoundException
:members:
:show-inheritance:
:undoc-members: