Skip to content

Conversation

shermanjasonaf
Copy link
Contributor

@shermanjasonaf shermanjasonaf commented Sep 23, 2025

Summary/Motivation:

This PR restructures the PyROS online documentation and adds a new tutorial to the documentation.

Changes proposed in this PR:

  • Reorganize the PyROS online documentation and split it into multiple webpages
  • Add a new, extensive tutorial to the PyROS online documentation
  • Replace the original quickstart example problem with a problem that is smaller, easier to write down, and less sensitive to the subsolver(s) used (see this comment of #3649)
  • Add the mathematical definition of each pre-implemented PyROS UncertaintySet class to the class's docstring

TODO (after #3732 merged)

  • Account for changes to the logging system in the restructured online docs
  • Rename the new PyROS doc folder as "pyros", and make the original PyROS reST file reference the main page of the new PyROS doc folder
  • Update version number, changelog

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.

@mrmundt
Copy link
Contributor

mrmundt commented Oct 7, 2025

@shermanjasonaf - Please resolve the merge conflicts.

@mrmundt mrmundt moved this from Todo to Review In Progress in Pyomo 6.9.5 Release Oct 7, 2025
@github-project-automation github-project-automation bot moved this from Review In Progress to Reviewer Approved in Pyomo 6.9.5 Release Oct 17, 2025
@blnicho
Copy link
Member

blnicho commented Oct 17, 2025

@shermanjasonaf there are a few unchecked TODO items in the PR description. Do you want us to wait on merging this until those are addressed?

@blnicho
Copy link
Member

blnicho commented Oct 17, 2025

Merging this without waiting for the rest of the tests because it's only touching documentation and not functionality

@blnicho blnicho merged commit 0ef6524 into Pyomo:main Oct 17, 2025
32 of 33 checks passed
@github-project-automation github-project-automation bot moved this from Reviewer Approved to Done in Pyomo 6.9.5 Release Oct 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

No open projects

Development

Successfully merging this pull request may close these issues.

5 participants