Repository navigation
chore: sync conf.py extensions with docs dependencies listed in requirements folder - #130
Merged
sbillinge merged 3 commits intoAug 6, 2025
Merged
sbillinge merged 3 commits into
sbillinge merged 3 commits into
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
zmx27
marked this pull request as ready for review
August 6, 2025 19:44
Copy link
Copy Markdown
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## main #130 +/- ##
=======================================
Coverage 66.60% 66.60%
=======================================
Files 25 25
Lines 3171 3171
=======================================
Hits 2112 2112
Misses 1059 1059
|
Sorry, something went wrong.
sbillinge
reviewed
Aug 6, 2025
sbillinge
left a comment
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
It is better if we can go with m2r2 rather than m2r which is no longer maintained. Do things build correctly if we do that?
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
Author
|
@sbillinge yes, I've tested it locally and the docs will still build correctly if we use m2r2. I've updated conf.py and the requirements folder to now use m2r2 instead of m2r. This is ready for review. |
Sorry, something went wrong.
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 problem does this PR address?
In requirements/docs.txt, m2r is installed as a dependency when the docs are being built. However, docs/source/conf.py lists m2r2 instead of m2r as one of the extensions being used by Sphinx to build the docs. This causes an error when building the docs. This PR fixes this error by updating the conf.py extensions so it is in sync with the dependencies listed in requirements/docs.txt.
What should the reviewer(s) do?
Please review and merge.