fix: Pegleg exceptions documentation incorrectly rendering
This patch set changes Pegleg'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-pegleg.readthedocs.io/en/latest/exceptions.html Change-Id: Ie4bc01f1fe6aee9b9a58fd956f5b350df44bef51
This commit is contained in:
parent
893ea9f4bb
commit
33fe583e08
|
@ -20,53 +20,39 @@ Pegleg Exceptions
|
||||||
Base Exceptions
|
Base Exceptions
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
.. list-table::
|
.. autoexception:: pegleg.engine.exceptions.PeglegBaseException
|
||||||
:widths: 5 50
|
:members:
|
||||||
:header-rows: 1
|
:undoc-members:
|
||||||
|
|
||||||
* - Exception Name
|
|
||||||
- Description
|
|
||||||
* - PeglegBaseException
|
|
||||||
- .. autoexception:: pegleg.engine.exceptions.PeglegBaseException
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
|
|
||||||
Git Exceptions
|
Git Exceptions
|
||||||
--------------
|
--------------
|
||||||
|
|
||||||
.. list-table::
|
.. autoexception:: pegleg.engine.exceptions.BaseGitException
|
||||||
:widths: 5 50
|
:members:
|
||||||
:header-rows: 1
|
:show-inheritance:
|
||||||
|
:undoc-members:
|
||||||
|
|
||||||
* - Exception Name
|
.. autoexception:: pegleg.engine.exceptions.GitConfigException
|
||||||
- Description
|
:members:
|
||||||
* - BaseGitException
|
:show-inheritance:
|
||||||
- .. autoexception:: pegleg.engine.exceptions.BaseGitException
|
:undoc-members:
|
||||||
:members:
|
|
||||||
:show-inheritance:
|
.. autoexception:: pegleg.engine.exceptions.GitException
|
||||||
:undoc-members:
|
:members:
|
||||||
* - GitConfigException
|
:show-inheritance:
|
||||||
- .. autoexception:: pegleg.engine.exceptions.GitConfigException
|
:undoc-members:
|
||||||
:members:
|
|
||||||
:show-inheritance:
|
.. autoexception:: pegleg.engine.exceptions.GitAuthException
|
||||||
:undoc-members:
|
:members:
|
||||||
* - GitException
|
:show-inheritance:
|
||||||
- .. autoexception:: pegleg.engine.exceptions.GitException
|
:undoc-members:
|
||||||
:members:
|
|
||||||
:show-inheritance:
|
.. autoexception:: pegleg.engine.exceptions.GitProxyException
|
||||||
:undoc-members:
|
:members:
|
||||||
* - GitAuthException
|
:show-inheritance:
|
||||||
- .. autoexception:: pegleg.engine.exceptions.GitAuthException
|
:undoc-members:
|
||||||
:members:
|
|
||||||
:show-inheritance:
|
.. autoexception:: pegleg.engine.exceptions.GitSSHException
|
||||||
:undoc-members:
|
:members:
|
||||||
* - GitProxyException
|
:show-inheritance:
|
||||||
- .. autoexception:: pegleg.engine.exceptions.GitProxyException
|
:undoc-members:
|
||||||
:members:
|
|
||||||
:show-inheritance:
|
|
||||||
:undoc-members:
|
|
||||||
* - GitSSHException
|
|
||||||
- .. autoexception:: pegleg.engine.exceptions.GitSSHException
|
|
||||||
:members:
|
|
||||||
:show-inheritance:
|
|
||||||
:undoc-members:
|
|
||||||
|
|
Loading…
Reference in New Issue