From dec7666defb99472ef23308e3a2ff1427701b210 Mon Sep 17 00:00:00 2001 From: Felipe Monteiro Date: Sun, 23 Sep 2018 12:32:51 -0400 Subject: [PATCH] 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 --- doc/source/exceptions.rst | 63 +++++++++++++++++---------------------- 1 file changed, 28 insertions(+), 35 deletions(-) diff --git a/doc/source/exceptions.rst b/doc/source/exceptions.rst index 29a9f1c7..0826ba7f 100644 --- a/doc/source/exceptions.rst +++ b/doc/source/exceptions.rst @@ -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: