-
Notifications
You must be signed in to change notification settings - Fork 518
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
Autogenerate API documentation #3378
Conversation
… autodoc warnings
(This normalizes the doc strings to avoid indention warnings from Sphinx)
model.o = pyo.Objective(expr=model.v1 + model.v2) | ||
solver = pyo.SolverFactory('glpk') | ||
input_vars = [model.v1] | ||
n_scen = 2 |
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.
Not relevant for this PR but marking for posterity - what is n_scen
?
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 believe "number of scenarios"
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.
Yes yes, I am pleased.
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 Reference
Reference
/Topical Reference
alpha
format for all references (that are not references to Pyomo publications)sphinx.ext.autosectionlabel
ConfigDict
numpydoc generation (improve references, resolve sphinx warnings)IntEnum
wrapper to rewrite some docstrings to silence Sphinx warnings__init__.py
files (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: