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
This commit is contained in:
Felipe Monteiro 2018-09-23 12:32:51 -04:00
parent d066a5c7b3
commit dec7666def
1 changed files with 28 additions and 35 deletions

View File

@ -18,39 +18,32 @@
Promenade Exceptions
====================
.. list-table::
:widths: 5 50
:header-rows: 1
.. autoexception:: promenade.exceptions.ApiError
:members:
:show-inheritance:
:undoc-members:
* - Exception Name
- Description
* - ApiError
- .. autoexception:: promenade.exceptions.ApiError
:members:
:show-inheritance:
:undoc-members:
* - InvalidFormatError
- .. autoexception:: promenade.exceptions.InvalidFormatError
:members:
:show-inheritance:
:undoc-members:
* - ValidationException
- .. autoexception:: promenade.exceptions.ValidationException
:members:
:show-inheritance:
:undoc-members:
* - KubernetesConfigException
- .. autoexception:: promenade.exceptions.KubernetesConfigException
:members:
:show-inheritance:
:undoc-members:
* - KubernetesApiError
- .. autoexception:: promenade.exceptions.KubernetesApiError
:members:
:show-inheritance:
:undoc-members:
* - NodeNotFoundException
- .. autoexception:: promenade.exceptions.NodeNotFoundException
: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: