Address docs build failure on readthedocs #568
Merged
Conversation
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
Signed-off-by: M Q <[email protected]>
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates Sphinx documentation dependencies and configuration to use newer versions and API standards. The changes focus on upgrading Sphinx-related packages and updating deprecated myst-nb configuration options.
Key changes:
- Updated Sphinx and related package versions with more explicit version constraints
- Migrated myst-nb configuration from deprecated to current API (
execution_in_temp→nb_execution_in_temp,jupyter_execute_notebooks→nb_execution_mode) - Removed redundant bibtex configuration section (already defined elsewhere in conf.py)
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/requirements.txt | Updated version constraints for Sphinx (>=5.3.0,<8.0.0) and added minimum versions for sphinx-thebe and sphinx-autodoc-typehints |
| docs/source/conf.py | Updated myst-nb configuration options to current API and removed duplicate bibtex configuration |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
MMelQin
added a commit
that referenced
this pull request
Nov 5, 2025
Signed-off-by: M Q <[email protected]>
MMelQin
added a commit
that referenced
this pull request
Nov 5, 2025
Signed-off-by: M Q <[email protected]>
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.
This PR updates Sphinx documentation dependencies and configuration to use newer versions and API standards to address the doc build issues on readthedoc. Local dev builds have been succeeding without issues.
The changes focus on upgrading Sphinx-related packages and updating deprecated myst-nb configuration options.
Key changes: