Skip to content

Fix RTD build: mock remaining runtime dependencies#92

Merged
JE-Chen merged 1 commit intomainfrom
dev
Apr 27, 2026
Merged

Fix RTD build: mock remaining runtime dependencies#92
JE-Chen merged 1 commit intomainfrom
dev

Conversation

@JE-Chen
Copy link
Copy Markdown
Member

@JE-Chen JE-Chen commented Apr 27, 2026

Summary

RTD only installs docs/requirements.txt (sphinx + theme + mermaid), so any
top-level project dependency not listed in autodoc_mock_imports aborts the
autosummary import sweep with ModuleNotFoundError. Reproduced in a clean
local venv that mirrors RTD's setup (no selenium / webdriver_manager / requests
/ dotenv / defusedxml installed).

Added the missing four mocks to docs/source/conf.py:

  • webdriver_manager (the actual culprit reported in the latest RTD log)
  • requests
  • dotenv
  • defusedxml

After the change sphinx-build -W --keep-going succeeds in the selenium-less
venv with zero warnings.

Test plan

  • RTD build green (latest + stable)
  • cd docs && python -m sphinx -b html -W --keep-going source build/html clean in a venv that lacks the project deps

@sonarqubecloud
Copy link
Copy Markdown

@codacy-production
Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@JE-Chen JE-Chen merged commit 8af4e5d into main Apr 27, 2026
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant