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

Update docs to use IDAES/examples instead of IDAES/examples-pse #1132

Merged
merged 24 commits into from
Apr 28, 2023

Conversation

dangunter
Copy link
Member

Fixes #1131

Summary/Motivation:

Documentation needs to point to the new examples

Changes proposed in this PR:

  • Fix links and associated description
  • Update installation steps

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 license terms described in the LICENSE.txt file at the top level of this directory.
  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.

@dangunter dangunter self-assigned this Mar 14, 2023
@codecov
Copy link

codecov bot commented Mar 14, 2023

Codecov Report

Patch coverage has no change and project coverage change: -0.01 ⚠️

Comparison is base (0ae7a98) 76.35% compared to head (4d5147b) 76.35%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1132      +/-   ##
==========================================
- Coverage   76.35%   76.35%   -0.01%     
==========================================
  Files         369      369              
  Lines       60715    60715              
  Branches    11198    11198              
==========================================
- Hits        46359    46356       -3     
- Misses      11954    11958       +4     
+ Partials     2402     2401       -1     

see 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@ksbeattie ksbeattie added the Priority:High High Priority Issue or PR label Mar 16, 2023
@ksbeattie
Copy link
Member

Nitpick: I kinda liked the diataxis table with the somewhat smaller fonts...

@andrewlee94 andrewlee94 self-requested a review April 6, 2023 17:20
@andrewlee94 andrewlee94 added the documentation Documentations comments and requests label Apr 6, 2023
@andrewlee94
Copy link
Member

@dangunter It looks like the docs build for this PR has expired; could you fix the conflict so that the docs can be rebuilt. Note that our supported Python versions are now 3.8-3.11.

@dangunter dangunter requested a review from MAZamarripa April 20, 2023 18:14
@dangunter
Copy link
Member Author

@andrewlee94 @MAZamarripa and @lbianchi-lbl this is ready for review now

Copy link
Member

@andrewlee94 andrewlee94 left a comment

Choose a reason for hiding this comment

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

Only one minor comment on updating the supported Python versions, but otherwise looks good to me.

Copy link
Member

@ksbeattie ksbeattie left a comment

Choose a reason for hiding this comment

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

LGTM

@andrewlee94 andrewlee94 enabled auto-merge (squash) April 28, 2023 18:18
@andrewlee94 andrewlee94 merged commit bb403dd into IDAES:main Apr 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentations comments and requests Priority:High High Priority Issue or PR
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Use IDAES/examples instead of IDAES/examples-pse
4 participants