Skip to content
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

Merged
merged 2 commits into from
Feb 1, 2018
Merged

Reorganize the API documentation. #333

merged 2 commits into from
Feb 1, 2018

Conversation

jsiirola
Copy link
Member

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:

  • Reorganize the TOC for the Library Reference to split out beta and third-party documentation.

Legal Acknowledgement

By contributing to this software project, I 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.

Split the API documentation to differentiate between core functionality,
beta functionality, and third-party documentation.
@jsiirola jsiirola requested a review from ghackebeil January 31, 2018 18:20
@qtothec
Copy link
Contributor

qtothec commented Jan 31, 2018

It'd be nice if read_the_docs also built relevant PRs.

@jsiirola
Copy link
Member Author

@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)

@blnicho
Copy link
Member

blnicho commented Jan 31, 2018

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"third" parties

@codecov-io
Copy link

Codecov Report

Merging #333 into master will increase coverage by 0.05%.
The diff coverage is n/a.

Impacted file tree graph

@@            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
Impacted Files Coverage Δ
pyomo/core/kernel/component_matrix_constraint.py 100% <0%> (ø) ⬆️
examples/doc/pyomobook/data-abstract-ch/ABCD7.py 80% <0%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 380933e...f42a918. Read the comment docs.

@jsiirola
Copy link
Member Author

jsiirola commented Feb 1, 2018

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).

@jsiirola jsiirola merged commit e7a3174 into master Feb 1, 2018
@jsiirola jsiirola deleted the api-doc-clarification branch February 2, 2018 04:39
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.

4 participants