Fix: Pegleg Exceptions docs rendering on RTD

Readthedocs failed to render Pegleg exceptions with error:
> WARNING: autodoc: failed to import exception ... from module
> 'pegleg'; the following exception was raised: No module named 'click'

Trying to add Pegleg requirements to the installed requirements list,
so that Readthedocs has all modules, including those needed for the
Pegleg itself.

Change-Id: I1780a9be3aeb0c3e2e775cbb1f713c2033f13e08
This commit is contained in:
Roman Gorshunov 2019-07-11 15:57:58 +02:00
parent d39c67046b
commit 31e5b898a2
3 changed files with 39 additions and 11 deletions

25
.readthedocs.yaml Normal file
View File

@ -0,0 +1,25 @@
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: doc/source/conf.py
# Build documentation with MkDocs
#mkdocs:
# configuration: mkdocs.yml
# Optionally build your docs in additional formats such as PDF and ePub
formats:
- pdf
# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.7
install:
- requirements: doc/requirements.txt
- requirements: requirements.txt

View File

@ -103,6 +103,7 @@ docs: clean
.PHONY: clean .PHONY: clean
clean: clean:
rm -rf build rm -rf build
rm -rf doc/build
.PHONY: py_lint .PHONY: py_lint
py_lint: py_lint:

View File

@ -17,42 +17,44 @@
Pegleg Exceptions Pegleg Exceptions
================== ==================
.. currentmodule:: pegleg.engine.exceptions
Base Exceptions Base Exceptions
--------------- ---------------
.. autoexception:: pegleg.engine.exceptions.PeglegBaseException .. autoexception:: PeglegBaseException
:members: :members:
:undoc-members: :undoc-members:
Git Exceptions Git Exceptions
-------------- --------------
.. autoexception:: pegleg.engine.exceptions.GitConfigException .. autoexception:: GitConfigException
:members: :members:
:show-inheritance: :show-inheritance:
:undoc-members: :undoc-members:
.. autoexception:: pegleg.engine.exceptions.GitException .. autoexception:: GitException
:members: :members:
:show-inheritance: :show-inheritance:
:undoc-members: :undoc-members:
.. autoexception:: pegleg.engine.exceptions.GitAuthException .. autoexception:: GitAuthException
:members: :members:
:show-inheritance: :show-inheritance:
:undoc-members: :undoc-members:
.. autoexception:: pegleg.engine.exceptions.GitProxyException .. autoexception:: GitProxyException
:members: :members:
:show-inheritance: :show-inheritance:
:undoc-members: :undoc-members:
.. autoexception:: pegleg.engine.exceptions.GitSSHException .. autoexception:: GitSSHException
:members: :members:
:show-inheritance: :show-inheritance:
:undoc-members: :undoc-members:
.. autoexception:: pegleg.engine.exceptions.GitInvalidRepoException .. autoexception:: GitInvalidRepoException
:members: :members:
:show-inheritance: :show-inheritance:
:undoc-members: :undoc-members:
@ -67,24 +69,24 @@ Authentication Exceptions
PKI Exceptions PKI Exceptions
-------------- --------------
.. autoexception:: pegleg.engine.exceptions.IncompletePKIPairError .. autoexception:: IncompletePKIPairError
Genesis Bundle Exceptions Genesis Bundle Exceptions
------------------------- -------------------------
.. autoexception:: pegleg.engine.exceptions.GenesisBundleEncryptionException .. autoexception:: GenesisBundleEncryptionException
:members: :members:
:show-inheritance: :show-inheritance:
:undoc-members: :undoc-members:
.. autoexception:: pegleg.engine.exceptions.GenesisBundleGenerateException .. autoexception:: GenesisBundleGenerateException
:members: :members:
:show-inheritance: :show-inheritance:
Passphrase Exceptions Passphrase Exceptions
--------------------- ---------------------
.. autoexception:: pegleg.engine.exceptions.PassphraseCatalogNotFoundException .. autoexception:: PassphraseCatalogNotFoundException
:members: :members:
:show-inheritance: :show-inheritance:
:undoc-members: :undoc-members: