Pinning package requirements for readthedocs #575
Merged
Conversation
This file contains 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
Minor version updates to multiple packages used in the generation of the documentation introduce dependencies needing Sphinx >= 5.0, which breaks the sphinx extensions we use in documenting the MOM6 APIs. I have added versions for all the packages needed to keep things working with Sphinx4 for now, but we really do need to find a way to work with the newer versions. More pinningaof of requirements for readthedocs More pinning of requirements for readthedocs
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## dev/gfdl #575 +/- ##
=========================================
Coverage 37.20% 37.20%
=========================================
Files 271 271
Lines 80472 80472
Branches 15008 15008
=========================================
Hits 29943 29943
Misses 44957 44957
Partials 5572 5572 ☔ View full report in Codecov by Sentry. |
|
Could you say more about the Sphinx4 extensions that we are using in MOM6 that are problematic with Sphinx5. How widespread are they, and how much work would it be to avoid using them? |
|
This discussion tab is a bit out of date, but it's probably the last time we really understood the problem: mom-ocean#1378 |
marshallward
approved these changes
Mar 2, 2024
|
Adding this in, but we need to get our docgen problems sorted out. At the least, things need to work with the latest versions of our toolchains (doxygen, sphinx, and sphinxcontrib packages). |
This was referenced May 16, 2024
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.
Minor version updates to multiple packages used in the generation of the documentation introduce dependencies needing Sphinx >= 5.0, which breaks the sphinx extensions we use in documenting the MOM6 APIs. I have added versions for all the packages needed to keep things working with Sphinx4 for now, but we really do need to find a way to work with the newer versions.
More pinningaof of requirements for readthedocs
More pinning of requirements for readthedocs