Skip to content

Update autosummary for Sphinx 8.2.1#3492

Merged
jsiirola merged 2 commits intoPyomo:mainfrom
jsiirola:sphinx-8.2.1
Feb 25, 2025
Merged

Update autosummary for Sphinx 8.2.1#3492
jsiirola merged 2 commits intoPyomo:mainfrom
jsiirola:sphinx-8.2.1

Conversation

@jsiirola
Copy link
Copy Markdown
Member

Fixes # .

Summary/Motivation:

This resolves RTD failures induced by Sphinx changing their API in 8.2.1.

Changes proposed in this PR:

  • Update Pyomo's generate_autosummart_content wrapper to track Sphinx API change
  • Update ExtendedEnumMeta to include enum members from base enum in the results from dir(). This will ensure base enum members are documented by Sphinx

Legal Acknowledgement

By contributing to this software project, I have read the contribution guide and agree to the following terms and conditions for my contribution:

  1. I agree my contributions are submitted under the BSD license.
  2. I represent I am authorized to make the contributions and grant the license. If my employer has rights to intellectual property that includes these contributions, I represent that I have received permission to make contributions and grant the required license on behalf of that employer.

@jsiirola jsiirola merged commit d0b7992 into Pyomo:main Feb 25, 2025
34 checks passed
@jsiirola jsiirola deleted the sphinx-8.2.1 branch February 25, 2025 04:57
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.

2 participants