Resolve incompatibilities between autosummary plugin and Sphinx 9.x#3818
Merged
blnicho merged 15 commits intoPyomo:mainfrom Jan 19, 2026
Merged
Resolve incompatibilities between autosummary plugin and Sphinx 9.x#3818blnicho merged 15 commits intoPyomo:mainfrom
blnicho merged 15 commits intoPyomo:mainfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3818 +/- ##
==========================================
- Coverage 89.43% 89.43% -0.01%
==========================================
Files 906 905 -1
Lines 105445 105422 -23
==========================================
- Hits 94307 94286 -21
+ Misses 11138 11136 -2
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:
|
mrmundt
reviewed
Jan 19, 2026
mrmundt
approved these changes
Jan 19, 2026
Contributor
mrmundt
left a comment
There was a problem hiding this comment.
I am fine with this as-is but have one silly nitpick.
Removed duplicate directory path definitions for HTML build.
blnicho
approved these changes
Jan 19, 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.
Fixes #N/A; Follow-on to #3815.
Summary/Motivation:
#3815 got the documentation builds running again, but the custom Sphinx extensions were not getting correctly activated / run. This PR is a follow-on that monkey-patches additional functions within Sphinx's
autosummaryextensions so that Pyomo's extensions will run correctly in Sphinx 9.x.This PR also adds tests for verifying that Sphinx is generating correct html:
(Note that this PR will initially fail tests -- I am checking that the new unit tests pick up the sphinx-doc/sphinx#14223 error)
This PR will also disallow 9.0.x and 9.1 because of the reference bug.
Changes proposed in this PR:
autodoc_use_legacy_class_basedLegal Acknowledgement
By contributing to this software project, I have read the contribution guide and agree to the following terms and conditions for my contribution: