-
Notifications
You must be signed in to change notification settings - Fork 525
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
Reorganize the API documentation. #333
Conversation
Split the API documentation to differentiate between core functionality, beta functionality, and third-party documentation.
It'd be nice if read_the_docs also built relevant PRs. |
@qtothec: agreed. Unfortunately, we haven't been able to figure out how to make that happen automatically. There appear to be issues tracking this feature request for RTD (readthedocs/readthedocs.org#1340 and readthedocs/readthedocs.org#2465) |
If you view the full .rst file on github it gives you a slightly better preview of what it will look like than just looking at the raw text (minus the special linking done by Sphinx) |
@@ -1,5 +1,21 @@ | |||
Third-Party Contributions | |||
========================= | |||
|
|||
* `pyomo.contrib.simplemodel <http://pyomocontrib-simplemodel.readthedocs.io/en/latest/>`_ | |||
Pyomo includes a variety of additional features and functionality | |||
provided by thiry parties through the ``pyomo.contrib`` package. This |
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.
"third" parties
Codecov Report
@@ Coverage Diff @@
## master #333 +/- ##
=========================================
+ Coverage 65.65% 65.7% +0.05%
=========================================
Files 464 465 +1
Lines 60428 60534 +106
=========================================
+ Hits 39673 39776 +103
- Misses 20755 20758 +3
Continue to review full report at Codecov.
|
Spoke with @carldlaird, @blnicho, and @whart222: We agreed to merge this to clarify the Library docs, but hold off on any additional changes until after the 5.4 release and #272 is merged (which has a more extensive rework of the documentation hierarchy - in particular to distinguish between User API docs and Developer API docs). |
Split the API documentation to differentiate between core functionality, beta functionality, and third-party documentation.
Summary/Motivation:
We are starting to get user questions that reference the online documentation (a good thing!); however, they were referencing the Kernel documentation and implying that it would work for general Pyomo models (https://stackoverflow.com/questions/48538945/access-all-variables-occurring-in-a-pyomo-constraint). This change highlights that the Kernel is still "beta" -- mostly because that API should not (yet) be expected to work with models that general users would be creating.
Changes proposed in this PR:
Legal Acknowledgement
By contributing to this software project, I agree to the following terms and conditions for my contribution: