-
Notifications
You must be signed in to change notification settings - Fork 562
Resolve incompatibilities between autosummary plugin and Sphinx 9.x #3818
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
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
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am fine with this as-is but have one silly nitpick.
Removed duplicate directory path definitions for HTML build.
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: