Autogenerate API documentation#3378
Merged
jsiirola merged 82 commits intoPyomo:doc-reorgfrom Oct 11, 2024
Merged
Conversation
… autodoc warnings
(This normalizes the doc strings to avoid indention warnings from Sphinx)
mrmundt
reviewed
Oct 9, 2024
| model.o = pyo.Objective(expr=model.v1 + model.v2) | ||
| solver = pyo.SolverFactory('glpk') | ||
| input_vars = [model.v1] | ||
| n_scen = 2 |
Contributor
There was a problem hiding this comment.
Not relevant for this PR but marking for posterity - what is n_scen?
Member
Author
There was a problem hiding this comment.
I believe "number of scenarios"
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 # .
Summary/Motivation:
This PR is primarily adds the automatic generation of the API documentation for the entire Pyomo codebase to the Sphinx build.
This also silences all Sphinx warnings that were being generated
Changes proposed in this PR:
Reference/Library ReferenceReference/Topical Referencealphaformat for all references (that are not references to Pyomo publications)sphinx.ext.autosectionlabelConfigDictnumpydoc generation (improve references, resolve sphinx warnings)IntEnumwrapper to rewrite some docstrings to silence Sphinx warnings__init__.pyfiles (resolves Sphinx autosummary issue)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: