Skip to content

Pinning package requirements for readthedocs#575

Merged
marshallward merged 2 commits into
NOAA-GFDL:dev/gfdlfrom
adcroft:rtfd-fix-versions
Mar 2, 2024
Merged

Pinning package requirements for readthedocs#575
marshallward merged 2 commits into
NOAA-GFDL:dev/gfdlfrom
adcroft:rtfd-fix-versions

Conversation

@adcroft
Copy link
Copy Markdown
Member

@adcroft adcroft commented Feb 29, 2024

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

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
Copy link
Copy Markdown

codecov Bot commented Feb 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 37.20%. Comparing base (d0e9c25) to head (dd11d86).

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.
📢 Have feedback on the report? Share it here.

@Hallberg-NOAA
Copy link
Copy Markdown
Member

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?

@marshallward
Copy link
Copy Markdown
Member

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 marshallward merged commit fd5696b into NOAA-GFDL:dev/gfdl Mar 2, 2024
@marshallward
Copy link
Copy Markdown
Member

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).

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.

3 participants