Skip to content

Use Sphinx's mocking for dependencies in the docs build #616

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
tompollard merged 1 commit into from
Nov 4, 2026
Merged

Use Sphinx's mocking for dependencies in the docs build #616

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 3 additions & 12 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,9 @@

sys.path.insert(0, os.path.abspath("../src"))

# For dependencies
from unittest.mock import MagicMock


class Mock(MagicMock):
@classmethod
def __getattr__(cls, name):
return MagicMock()


MOCK_MODULES = ["numpy", "matplotlib", "matplotlib.pyplot", "pandas", "scipy"]
sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
# Heavy dependencies aren't installed for the docs build. Sphinx mocks them, and
# shows mocked names in signatures (e.g. `pandas.DataFrame`).
autodoc_mock_imports = ["numpy", "matplotlib", "pandas", "scipy"]

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

Expand Down
Loading