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

docs: add Mechanical API link to Mechanical Scripting page #972

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

klmcadams
Copy link
Collaborator

@klmcadams klmcadams commented Nov 6, 2024

Closes #970

@klmcadams klmcadams requested a review from a team as a code owner November 6, 2024 16:51
@github-actions github-actions bot added documentation Improvements or additions to documentation enhancement New features or code improvements labels Nov 6, 2024
@klmcadams klmcadams changed the title doc: add Mechanical API link to Mechanical Scripting page docs: add Mechanical API link to Mechanical Scripting page Nov 6, 2024
Copy link

codecov bot commented Nov 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.27%. Comparing base (c526fb0) to head (0e564a1).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #972      +/-   ##
==========================================
- Coverage   85.53%   81.27%   -4.26%     
==========================================
  Files          36       36              
  Lines        2302     2302              
==========================================
- Hits         1969     1871      -98     
- Misses        333      431      +98     

Comment on lines +26 to +28
For comprehensive information on these APIs, see the
`Mechanical API Documentation <https://scripting.mechanical.docs.pyansys.com/version/dev/api/index.html>`_
and the `Scripting in Mechanical Guide`_ in the Ansys Help portal.
Copy link
Member

Choose a reason for hiding this comment

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

This should be added with a .. note:: so that users pay attention to it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New features or code improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Link scriptings.mechanical.docs.pyansys.com with the Mechanical docs
3 participants