Skip to content

Commit

Permalink
docs: autodoc_mock_imports for gssapi
Browse files Browse the repository at this point in the history
Adds mocking of  and  that cannot be installed on ReadTheDocs
builders.
This fixes the ReadTheDocs building problem.
closes #274
  • Loading branch information
Parth Shandilya committed Sep 29, 2020
1 parent a8d47d2 commit dd20a29
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
3 changes: 3 additions & 0 deletions docs/conf.py
Expand Up @@ -54,6 +54,9 @@
"sphinxcontrib.redoc",
]

# Autodoc mocking to fix ReadTheDocs builds missing system dependencies
autodoc_mock_imports = ["gssapi", "paramiko", "paramiko[gssapi]"]

redoc = [
{
"page": "_static/api",
Expand Down
15 changes: 14 additions & 1 deletion docs/requirements.txt
Expand Up @@ -4,4 +4,17 @@
# REANA is free software; you can redistribute it and/or modify it
# under the terms of the MIT License; see LICENSE file for more details.

-e .[all]
"sphinx"
"sphinx-rtd-theme>=0.1.9"
"sphinxcontrib-httpdomain>=1.5.0"
"sphinxcontrib-openapi>=0.3.0,<0.4.0"
"sphinxcontrib-redoc>=1.5.1"
"apispec>=0.21.0,<0.40"
"Flask>=0.11"
"werkzeug>=0.16.1,<0.17"
"fs>=2.0"
"marshmallow>2.13.0,<=2.20.1"
"reana-commons[kubernetes]>=0.8.0a1,<0.9.0"
"reana-db>=0.8.0a1,<0.9.0"
"htcondor==8.9.7"
"retrying>=1.3.3"

0 comments on commit dd20a29

Please sign in to comment.