Fixed doc site build fails#733
Merged
kennethshsu merged 2 commits intomainfrom May 1, 2026
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #733 +/- ##
=======================================
Coverage 85.25% 85.25%
=======================================
Files 85 85
Lines 4952 4952
Branches 645 645
=======================================
Hits 4222 4222
Misses 521 521
Partials 209 209
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
henrydingliu
approved these changes
May 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this pull request do?
Restored the doc site to its former glory!!!
This review might be a bit hard to read, but most of it is fixing the link code needed by readthedocs.
Relevant Github ticket(s)?
None, but the site should be alive after merging. It's already live on the side branch.
Note
Low Risk
Low risk: changes are confined to documentation build configuration and a small Sphinx extension import path fix, with no runtime/library behavior impact.
Overview
Fixes doc-site builds by ensuring the local
docs/_ext/linkcode.pyextension can be imported in standalone Sphinx/Read the Docs builds.This updates Jupyter Book/Sphinx config to register
linkcodecorrectly, prependsdocs/_extontosys.pathindocs/conf.py(and addsdocs/prep_sphinx_conf.pyto auto-inject that block afterjupyter-book config sphinxruns), and adjusts tests/pytest config so the extension is importable during CI. Also refreshes the PR template headings.Reviewed by Cursor Bugbot for commit 5f23ed5. Bugbot is set up for automated code reviews on this repo. Configure here.