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

Add Intersphinx mapping for use across PSE+ projects #1469

Closed
wants to merge 18 commits into from

Conversation

dangunter
Copy link
Member

@dangunter dangunter commented Aug 9, 2024

Fixes

Issue #1468

Changes proposed in this PR:

  • Create a tiny python module that can be used by other dependent projects to retrieve a canonical intersphinx mapping inside another projects' conf.py:
from idaes.util.intersphinx import get_intersphinx_mapping
# ...
intersphinx_mapping = get_intersphinx_mapping()
intersphinx_mapping.update({}) # add local mappings here

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.

@codecov-commenter
Copy link

codecov-commenter commented Aug 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.36%. Comparing base (94a3043) to head (95c79cf).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1469   +/-   ##
=======================================
  Coverage   76.36%   76.36%           
=======================================
  Files         394      395    +1     
  Lines       64953    64977   +24     
  Branches    14404    14408    +4     
=======================================
+ Hits        49601    49622   +21     
- Misses      12793    12797    +4     
+ Partials     2559     2558    -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@dangunter
Copy link
Member Author

Once this is merged it will be used in the idaes/examples, see IDAES/examples#132

@dangunter dangunter self-assigned this Aug 13, 2024
@dangunter dangunter changed the title Intersphinx 1468 Add Intersphinx mapping for use across PSE+ projects Aug 13, 2024
@dangunter dangunter added the documentation Documentations comments and requests label Aug 13, 2024
@ksbeattie ksbeattie added the Priority:Normal Normal Priority Issue or PR label Aug 15, 2024
@dangunter
Copy link
Member Author

Too complex

@dangunter dangunter closed this Aug 22, 2024
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:Normal Normal Priority Issue or PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants