From cd1e46b98e810b0c3dccd42a087462a613c78c7a Mon Sep 17 00:00:00 2001 From: James Derrick Date: Fri, 12 Jun 2026 13:41:14 +0100 Subject: [PATCH 1/8] Getting Started & ecosystem links I am currently working on reviewing and improving PyAnsys Getting Started sections and this work is part of that. It is reasonable to assume new users of PyMechanical will be familiar with Python and pip but not guaranteed. So I have added a note + link that makes it clearer what those items are for people that don't know when they first get mentioned in the docs. In addition, I have added a section on the Ansys wider developer ecosystem to the troubleshooting section including a set of links to places where users can expect to find resources that may be of assistance, such as the portal, forum AIS, ALH, etc. I have not been able to fully build the docs with the changes locally because I do not have Mechanical installed, however, the changes are sufficiently small that a code review should suffice. --- doc/source/getting_started/installation.rst | 6 ++++++ doc/source/getting_started/troubleshooting.rst | 11 +++++++++++ 2 files changed, 17 insertions(+) diff --git a/doc/source/getting_started/installation.rst b/doc/source/getting_started/installation.rst index 9bbd71208d..c25628cead 100644 --- a/doc/source/getting_started/installation.rst +++ b/doc/source/getting_started/installation.rst @@ -24,6 +24,12 @@ a reference: Install the package ------------------- +.. note:: + These instructions assume you are familiar + with ``pip`` and the command line. If they are new to you, you should read + the `Python Packaging User Guide Tutorial on pip ` + before proceeding. + The latest ``ansys.mechanical.core`` package supports Python 3.10 through Python 3.14 on Windows, Linux, and Mac. diff --git a/doc/source/getting_started/troubleshooting.rst b/doc/source/getting_started/troubleshooting.rst index 12aa08a33c..0fc92843bc 100644 --- a/doc/source/getting_started/troubleshooting.rst +++ b/doc/source/getting_started/troubleshooting.rst @@ -111,3 +111,14 @@ VPN issues Sometimes, Mechanical has issues starting when VPN software is running. For more information, see the `Mechanical Users Guide`_ in the Ansys Help. + +Ansys developer ecosystem resources +----------------------------------- + +Ansys has an extensive developer ecosystem where you can find assistance for a variety of issues. + +- `Developer Portal `: Blog posts, documentation, and guide + - `Developer Forum `: Scripting and usage support for PyAnsys and other Ansys developer tools +- `Ansys Innovation Space `: Product support forum and training materials +- `GitHub `: Development support, bug reporting, feature requests, and more. +- `Ansys Learning Hub `: Training, courses and learning plans From c06c8ed7cce42fe9fc6b811c1418bd5400ee2f30 Mon Sep 17 00:00:00 2001 From: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com> Date: Fri, 12 Jun 2026 12:50:51 +0000 Subject: [PATCH 2/8] chore: adding changelog file 1655.documentation.md [dependabot-skip] --- doc/changelog.d/1655.documentation.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 doc/changelog.d/1655.documentation.md diff --git a/doc/changelog.d/1655.documentation.md b/doc/changelog.d/1655.documentation.md new file mode 100644 index 0000000000..35836651af --- /dev/null +++ b/doc/changelog.d/1655.documentation.md @@ -0,0 +1 @@ +Getting Started & ecosystem links From 214550e04127781eb374b3c6520d841f8103111e Mon Sep 17 00:00:00 2001 From: James Derrick Date: Fri, 12 Jun 2026 13:58:57 +0100 Subject: [PATCH 3/8] fixed broken pip tutorial link --- doc/source/getting_started/installation.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/getting_started/installation.rst b/doc/source/getting_started/installation.rst index c25628cead..fc3bef3d38 100644 --- a/doc/source/getting_started/installation.rst +++ b/doc/source/getting_started/installation.rst @@ -27,7 +27,7 @@ Install the package .. note:: These instructions assume you are familiar with ``pip`` and the command line. If they are new to you, you should read - the `Python Packaging User Guide Tutorial on pip ` + the `Python Packaging User Guide Tutorial on pip ` before proceeding. The latest ``ansys.mechanical.core`` package supports Python 3.10 through From ebcca66e7f3574761358061b56bba566319efdef Mon Sep 17 00:00:00 2001 From: James Derrick Date: Fri, 12 Jun 2026 14:35:08 +0100 Subject: [PATCH 4/8] Update doc/source/getting_started/installation.rst Co-authored-by: Dipin <26918585+dipinknair@users.noreply.github.com> --- doc/source/getting_started/installation.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/getting_started/installation.rst b/doc/source/getting_started/installation.rst index fc3bef3d38..0cbf987813 100644 --- a/doc/source/getting_started/installation.rst +++ b/doc/source/getting_started/installation.rst @@ -27,7 +27,7 @@ Install the package .. note:: These instructions assume you are familiar with ``pip`` and the command line. If they are new to you, you should read - the `Python Packaging User Guide Tutorial on pip ` + the `Python Packaging User Guide Tutorial on pip _` before proceeding. The latest ``ansys.mechanical.core`` package supports Python 3.10 through From 0bed0b2c5c17c6248054780bea1ecde03d4a8f56 Mon Sep 17 00:00:00 2001 From: James Derrick Date: Fri, 12 Jun 2026 14:35:17 +0100 Subject: [PATCH 5/8] Update doc/source/getting_started/installation.rst Co-authored-by: Dipin <26918585+dipinknair@users.noreply.github.com> --- doc/source/getting_started/installation.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/source/getting_started/installation.rst b/doc/source/getting_started/installation.rst index 0cbf987813..5b00a3260d 100644 --- a/doc/source/getting_started/installation.rst +++ b/doc/source/getting_started/installation.rst @@ -25,6 +25,7 @@ Install the package ------------------- .. note:: + These instructions assume you are familiar with ``pip`` and the command line. If they are new to you, you should read the `Python Packaging User Guide Tutorial on pip _` From 6d0633488a00bf64947d884d4f72bb7e3cbac6c9 Mon Sep 17 00:00:00 2001 From: James Derrick Date: Fri, 12 Jun 2026 14:35:28 +0100 Subject: [PATCH 6/8] Update doc/source/getting_started/troubleshooting.rst Co-authored-by: Dipin <26918585+dipinknair@users.noreply.github.com> --- doc/source/getting_started/troubleshooting.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/getting_started/troubleshooting.rst b/doc/source/getting_started/troubleshooting.rst index 0fc92843bc..80921f0836 100644 --- a/doc/source/getting_started/troubleshooting.rst +++ b/doc/source/getting_started/troubleshooting.rst @@ -117,7 +117,7 @@ Ansys developer ecosystem resources Ansys has an extensive developer ecosystem where you can find assistance for a variety of issues. -- `Developer Portal `: Blog posts, documentation, and guide +- `Developer Portal `_: Blog posts, documentation, and guide - `Developer Forum `: Scripting and usage support for PyAnsys and other Ansys developer tools - `Ansys Innovation Space `: Product support forum and training materials - `GitHub `: Development support, bug reporting, feature requests, and more. From f65b2bb85edd2092b52cc5673ad6366d1abefeb3 Mon Sep 17 00:00:00 2001 From: James Derrick Date: Fri, 12 Jun 2026 14:35:37 +0100 Subject: [PATCH 7/8] Update doc/source/getting_started/troubleshooting.rst Co-authored-by: Dipin <26918585+dipinknair@users.noreply.github.com> --- doc/source/getting_started/troubleshooting.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/source/getting_started/troubleshooting.rst b/doc/source/getting_started/troubleshooting.rst index 80921f0836..1fe3f6dbbc 100644 --- a/doc/source/getting_started/troubleshooting.rst +++ b/doc/source/getting_started/troubleshooting.rst @@ -118,7 +118,7 @@ Ansys developer ecosystem resources Ansys has an extensive developer ecosystem where you can find assistance for a variety of issues. - `Developer Portal `_: Blog posts, documentation, and guide - - `Developer Forum `: Scripting and usage support for PyAnsys and other Ansys developer tools -- `Ansys Innovation Space `: Product support forum and training materials -- `GitHub `: Development support, bug reporting, feature requests, and more. -- `Ansys Learning Hub `: Training, courses and learning plans + - `Developer Forum `_: Scripting and usage support for PyAnsys and other Ansys developer tools +- `Ansys Innovation Space `_: Product support forum and training materials +- `GitHub `_: Development support, bug reporting, feature requests, and more. +- `Ansys Learning Hub `_: Training, courses and learning plans From 7210cca2fb471ae031b2f3d373374143ec2d75a2 Mon Sep 17 00:00:00 2001 From: James Derrick Date: Fri, 12 Jun 2026 14:39:40 +0100 Subject: [PATCH 8/8] Update doc/source/getting_started/installation.rst Co-authored-by: Dipin <26918585+dipinknair@users.noreply.github.com> --- doc/source/getting_started/installation.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/getting_started/installation.rst b/doc/source/getting_started/installation.rst index 5b00a3260d..f09dc0cf7e 100644 --- a/doc/source/getting_started/installation.rst +++ b/doc/source/getting_started/installation.rst @@ -27,7 +27,7 @@ Install the package .. note:: These instructions assume you are familiar - with ``pip`` and the command line. If they are new to you, you should read + with ``pip`` and the command line. If you are new to them, you should read the `Python Packaging User Guide Tutorial on pip _` before proceeding.