ansys / pyacp

Python Client for Ansys Composite PrepPost
https://acp.docs.pyansys.com
MIT License
5 stars 1 forks source link

Show which examples use an object in the API documentation #683

Closed greschd closed 6 days ago

greschd commented 1 week ago

Use the 'minigallery' feature of sphinx-gallery to show which examples use a specific feature in its API documentation.

Note that examples which are not rendered (i.e., the PyMechanical ones) do not show up. Also, uses within a function (defined in the example) do not seem to be captured.

However, where present, I think it's a nice way of linking the API reference to a usage example. When there are no examples, the section is not shown.

codecov[bot] commented 1 week ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 94.83%. Comparing base (699324d) to head (0350a1a).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #683 +/- ## ======================================= Coverage 94.83% 94.83% ======================================= Files 104 104 Lines 5688 5688 ======================================= Hits 5394 5394 Misses 294 294 ``` | [Flag](https://app.codecov.io/gh/ansys/pyacp/pull/683/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansys) | Coverage Δ | | |---|---|---| | [python-3.10](https://app.codecov.io/gh/ansys/pyacp/pull/683/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansys) | `94.62% <ø> (ø)` | | | [python-3.11](https://app.codecov.io/gh/ansys/pyacp/pull/683/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansys) | `94.54% <ø> (ø)` | | | [python-3.12](https://app.codecov.io/gh/ansys/pyacp/pull/683/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansys) | `94.76% <ø> (ø)` | | | [server-2024R2](https://app.codecov.io/gh/ansys/pyacp/pull/683/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansys) | `91.27% <ø> (ø)` | | | [server-2025R1](https://app.codecov.io/gh/ansys/pyacp/pull/683/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansys) | `94.54% <ø> (ø)` | | | [server-2025R2](https://app.codecov.io/gh/ansys/pyacp/pull/683/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansys) | `94.54% <ø> (ø)` | | | [server-latest](https://app.codecov.io/gh/ansys/pyacp/pull/683/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansys) | `94.62% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansys#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.


🚨 Try these New Features:

greschd commented 1 week ago

Example screenshot: image