From cfac4529f099b4a2effba2cb3688f23fcfcf6c95 Mon Sep 17 00:00:00 2001 From: Kerry McAdams <58492561+klmcadams@users.noreply.github.com> Date: Thu, 14 Nov 2024 11:10:05 -0500 Subject: [PATCH] docs: add Mechanical API link to Mechanical Scripting page (#972) Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com> Co-authored-by: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com> --- doc/changelog.d/972.documentation.md | 1 + doc/source/links.rst | 3 ++- doc/source/user_guide_scripting/index.rst | 7 +++++-- 3 files changed, 8 insertions(+), 3 deletions(-) create mode 100644 doc/changelog.d/972.documentation.md diff --git a/doc/changelog.d/972.documentation.md b/doc/changelog.d/972.documentation.md new file mode 100644 index 000000000..6474743c5 --- /dev/null +++ b/doc/changelog.d/972.documentation.md @@ -0,0 +1 @@ +add Mechanical API link to Mechanical Scripting page \ No newline at end of file diff --git a/doc/source/links.rst b/doc/source/links.rst index 589b90e68..40bf1f4ba 100644 --- a/doc/source/links.rst +++ b/doc/source/links.rst @@ -19,7 +19,8 @@ .. _Chapter 7: https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/%%VERSION%%/en/installation/win_silent.html .. # Mechanical related -.. _Mechanical scripting interface: https://developer.ansys.com/docs/mechanical-scripting-interface/api/index.md +.. _Mechanical API Documentation: https://scripting.mechanical.docs.pyansys.com/version/dev/api/index.html +.. _Mechanical scripting interface APIs: https://developer.ansys.com/docs/mechanical-scripting-interface/api/index.md .. _ACT API Reference Guide: https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/v242/en/act_ref/act_ref.html .. _Mechanical API known issues and limitations: https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/%%VERSION%%/en/act_script/mech_apis_KIL.html?q=known%20issues .. _ACT known issues and limitations: https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/%%VERSION%%/en/act_dev/act_dev_knownissues.html diff --git a/doc/source/user_guide_scripting/index.rst b/doc/source/user_guide_scripting/index.rst index 2280a98e7..808d51e95 100644 --- a/doc/source/user_guide_scripting/index.rst +++ b/doc/source/user_guide_scripting/index.rst @@ -23,8 +23,11 @@ You could already perform scripting of Mechanical with Python from inside Mechanical. PyMechanical leverages the same APIs but allows you to run your automation from outside Mechanical. -For comprehensive information on these APIs, see the `Scripting in Mechanical Guide`_ in the -Ansys Help. +.. note:: + + For comprehensive information on these APIs, see the `Scripting in Mechanical Guide`_ in the + Ansys Help portal, the `Mechanical scripting interface APIs`_ in the Developer Portal, or the + `Mechanical API Documentation`_. Recording ---------