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:
Felipe Monteiro 2018-09-23 12:39:52 -04:00
parent 893ea9f4bb
commit 33fe583e08
1 changed files with 31 additions and 45 deletions

View File

@ -20,53 +20,39 @@ Pegleg Exceptions
Base Exceptions
---------------
.. list-table::
:widths: 5 50
:header-rows: 1
* - Exception Name
- Description
* - PeglegBaseException
- .. autoexception:: pegleg.engine.exceptions.PeglegBaseException
:members:
:undoc-members:
.. autoexception:: pegleg.engine.exceptions.PeglegBaseException
:members:
:undoc-members:
Git Exceptions
--------------
.. list-table::
:widths: 5 50
:header-rows: 1
.. autoexception:: pegleg.engine.exceptions.BaseGitException
:members:
:show-inheritance:
:undoc-members:
* - Exception Name
- Description
* - BaseGitException
- .. autoexception:: pegleg.engine.exceptions.BaseGitException
:members:
:show-inheritance:
:undoc-members:
* - GitConfigException
- .. autoexception:: pegleg.engine.exceptions.GitConfigException
:members:
:show-inheritance:
:undoc-members:
* - GitException
- .. autoexception:: pegleg.engine.exceptions.GitException
:members:
:show-inheritance:
:undoc-members:
* - GitAuthException
- .. autoexception:: pegleg.engine.exceptions.GitAuthException
:members:
:show-inheritance:
:undoc-members:
* - GitProxyException
- .. autoexception:: pegleg.engine.exceptions.GitProxyException
:members:
:show-inheritance:
:undoc-members:
* - GitSSHException
- .. autoexception:: pegleg.engine.exceptions.GitSSHException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: pegleg.engine.exceptions.GitConfigException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: pegleg.engine.exceptions.GitException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: pegleg.engine.exceptions.GitAuthException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: pegleg.engine.exceptions.GitProxyException
:members:
:show-inheritance:
:undoc-members:
.. autoexception:: pegleg.engine.exceptions.GitSSHException
:members:
:show-inheritance:
:undoc-members: