Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Autodoc mocking imports #57

Merged
merged 2 commits into from
May 2, 2019
Merged

Autodoc mocking imports #57

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
51abe75
Avoid importing library for version
jklaise May 2, 2019
e16435e
Add mocking to autodoc to generate API docs
jklaise May 2, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,12 @@
author = 'Seldon Technologies Ltd'

# The short X.Y version
import alibi
#import alibi
exec(open('../../alibi/version.py').read())

version = alibi.__version__
version = __version__
# The full version, including alpha/beta/rc tags
release = alibi.__version__
release = __version__

# -- General configuration ---------------------------------------------------

Expand Down Expand Up @@ -68,6 +69,10 @@
apidoc_separate_modules = True
apidoc_extra_args = ['-d 6']

# mock imports
autodoc_mock_imports = ['numpy', 'pandas', 'sklearn', 'spacy', 'skimage', 'requests',
'cv2', 'bs4', 'keras', 'tensorflow', 'seaborn']

# Napoleon settings
napoleon_google_docstring = True
napoleon_numpy_docstring = True
Expand Down