From 71d0a67802d5906475ca4d32186ed0097380575c Mon Sep 17 00:00:00 2001 From: Revathyvenugopal162 Date: Tue, 27 May 2025 08:49:59 +0200 Subject: [PATCH 1/7] docs: add instructions to download from pypi --- .../getting-started/installing/linux.rst | 25 +++++++++++++++++++ .../getting-started/installing/windows.rst | 21 ++++++++++++++++ 2 files changed, 46 insertions(+) diff --git a/doc/source/getting-started/installing/linux.rst b/doc/source/getting-started/installing/linux.rst index d0511c8c..50a546de 100644 --- a/doc/source/getting-started/installing/linux.rst +++ b/doc/source/getting-started/installing/linux.rst @@ -3,11 +3,36 @@ Install PyWorkbench locally in Linux This page explains how to install PyWorkbench locally on a Linux platform. +* `Download from pypi <_Download-pypi_>`_ +* `Download artifacts <_Download-artifacts_>`_ + .. note:: The following instructions assume that you have a local installation of Workbench and a valid license in your machine. + +.. _Download-pypi: + +Download from pypi +================== +PyWorkbench is available on the `Python Package Index (PyPI) `_. +You can install PyWorkbench using the `pip `_ command: + +.. code-block:: shell + + python -m pip install ansys-workbench-core + +Varify the installation by running this code: + +.. code-block:: python + + from ansys.workbench.core import launch_workbench + launch_workbench() + + +.. _Download-artifacts: + Download artifacts ================== diff --git a/doc/source/getting-started/installing/windows.rst b/doc/source/getting-started/installing/windows.rst index ef5f382e..7de24cc2 100644 --- a/doc/source/getting-started/installing/windows.rst +++ b/doc/source/getting-started/installing/windows.rst @@ -8,6 +8,27 @@ This page explains how to install PyWorkbench locally on a Windows platform. The following instructions assume that you have a local installation of Workbench and a valid license in your machine. +.. _Download-pypi: + +Download from pypi +================== +PyWorkbench is available on the `Python Package Index (PyPI) `_. +You can install PyWorkbench using the `pip `_ command: + +.. code-block:: shell + + python -m pip install ansys-workbench-core + +Varify the installation by running this code: + +.. code-block:: python + + from ansys.workbench.core import launch_workbench + launch_workbench() + + +.. _Download-artifacts: + Download artifacts ================== From 2bc1320904e4ba9d716f725b9b309546daa7164f Mon Sep 17 00:00:00 2001 From: Revathyvenugopal162 Date: Tue, 27 May 2025 08:58:12 +0200 Subject: [PATCH 2/7] docs: add indents --- doc/source/getting-started/installing/linux.rst | 16 +++++++++------- .../getting-started/installing/windows.rst | 11 +++++++++-- 2 files changed, 18 insertions(+), 9 deletions(-) diff --git a/doc/source/getting-started/installing/linux.rst b/doc/source/getting-started/installing/linux.rst index 50a546de..252504c2 100644 --- a/doc/source/getting-started/installing/linux.rst +++ b/doc/source/getting-started/installing/linux.rst @@ -1,21 +1,23 @@ Install PyWorkbench locally in Linux #################################### -This page explains how to install PyWorkbench locally on a Linux platform. - -* `Download from pypi <_Download-pypi_>`_ -* `Download artifacts <_Download-artifacts_>`_ +This page explains how to install PyWorkbench locally on a Windows platform. .. note:: The following instructions assume that you have a local installation of Workbench and a valid license in your machine. +There are two ways to install PyWorkbench on Windows: + +* `Install from PyPI `_ +* `Download artifacts `_ .. _Download-pypi: -Download from pypi +Install from PyPI ================== + PyWorkbench is available on the `Python Package Index (PyPI) `_. You can install PyWorkbench using the `pip `_ command: @@ -23,13 +25,13 @@ You can install PyWorkbench using the `pip `_ com python -m pip install ansys-workbench-core -Varify the installation by running this code: +Verify the installation by running this code: .. code-block:: python from ansys.workbench.core import launch_workbench - launch_workbench() + launch_workbench() .. _Download-artifacts: diff --git a/doc/source/getting-started/installing/windows.rst b/doc/source/getting-started/installing/windows.rst index 7de24cc2..e8ab8e2a 100644 --- a/doc/source/getting-started/installing/windows.rst +++ b/doc/source/getting-started/installing/windows.rst @@ -8,10 +8,16 @@ This page explains how to install PyWorkbench locally on a Windows platform. The following instructions assume that you have a local installation of Workbench and a valid license in your machine. +There are two ways to install PyWorkbench on Windows: + +* `Install from PyPI `_ +* `Download artifacts `_ + .. _Download-pypi: -Download from pypi +Install from PyPI ================== + PyWorkbench is available on the `Python Package Index (PyPI) `_. You can install PyWorkbench using the `pip `_ command: @@ -19,11 +25,12 @@ You can install PyWorkbench using the `pip `_ com python -m pip install ansys-workbench-core -Varify the installation by running this code: +Verify the installation by running this code: .. code-block:: python from ansys.workbench.core import launch_workbench + launch_workbench() From 7024cd0b2711c1f9ae11d72f5c852945416b6333 Mon Sep 17 00:00:00 2001 From: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com> Date: Tue, 27 May 2025 07:00:14 +0000 Subject: [PATCH 3/7] chore: adding changelog file 219.documentation.md [dependabot-skip] --- doc/changelog.d/219.documentation.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 doc/changelog.d/219.documentation.md diff --git a/doc/changelog.d/219.documentation.md b/doc/changelog.d/219.documentation.md new file mode 100644 index 00000000..0ca0bd89 --- /dev/null +++ b/doc/changelog.d/219.documentation.md @@ -0,0 +1 @@ +docs: improve install instructions by adding pypi install \ No newline at end of file From 8807d21edbdb7887ee10506775b2f52511a33a18 Mon Sep 17 00:00:00 2001 From: Revathyvenugopal162 Date: Tue, 27 May 2025 09:01:48 +0200 Subject: [PATCH 4/7] fix: build error --- doc/source/getting-started/installing/linux.rst | 6 ++---- doc/source/getting-started/installing/windows.rst | 9 ++------- 2 files changed, 4 insertions(+), 11 deletions(-) diff --git a/doc/source/getting-started/installing/linux.rst b/doc/source/getting-started/installing/linux.rst index 252504c2..e5937ef3 100644 --- a/doc/source/getting-started/installing/linux.rst +++ b/doc/source/getting-started/installing/linux.rst @@ -10,10 +10,9 @@ This page explains how to install PyWorkbench locally on a Windows platform. There are two ways to install PyWorkbench on Windows: -* `Install from PyPI `_ -* `Download artifacts `_ +* `Install from PyPI `_ +* `Download artifacts `_ -.. _Download-pypi: Install from PyPI ================== @@ -33,7 +32,6 @@ Verify the installation by running this code: launch_workbench() -.. _Download-artifacts: Download artifacts ================== diff --git a/doc/source/getting-started/installing/windows.rst b/doc/source/getting-started/installing/windows.rst index e8ab8e2a..5daf7634 100644 --- a/doc/source/getting-started/installing/windows.rst +++ b/doc/source/getting-started/installing/windows.rst @@ -10,10 +10,8 @@ This page explains how to install PyWorkbench locally on a Windows platform. There are two ways to install PyWorkbench on Windows: -* `Install from PyPI `_ -* `Download artifacts `_ - -.. _Download-pypi: +* `Install from PyPI `_ +* `Download artifacts `_ Install from PyPI ================== @@ -33,9 +31,6 @@ Verify the installation by running this code: launch_workbench() - -.. _Download-artifacts: - Download artifacts ================== From 74f8ef02870e8b2c3860f8e50ab0fe7119d70846 Mon Sep 17 00:00:00 2001 From: Revathyvenugopal162 Date: Tue, 3 Jun 2025 08:53:29 +0200 Subject: [PATCH 5/7] fix: typo --- doc/source/getting-started/installing/linux.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/source/getting-started/installing/linux.rst b/doc/source/getting-started/installing/linux.rst index e5937ef3..ea815622 100644 --- a/doc/source/getting-started/installing/linux.rst +++ b/doc/source/getting-started/installing/linux.rst @@ -1,14 +1,14 @@ Install PyWorkbench locally in Linux #################################### -This page explains how to install PyWorkbench locally on a Windows platform. +This page explains how to install PyWorkbench locally on a Linux platform. .. note:: The following instructions assume that you have a local installation of Workbench and a valid license in your machine. -There are two ways to install PyWorkbench on Windows: +There are two ways to install PyWorkbench on Linux: * `Install from PyPI `_ * `Download artifacts `_ From 8cd739e463696eaf96a94855755ec1bfab8a8391 Mon Sep 17 00:00:00 2001 From: Revathy Venugopal <104772255+Revathyvenugopal162@users.noreply.github.com> Date: Tue, 3 Jun 2025 08:54:51 +0200 Subject: [PATCH 6/7] Update doc/source/getting-started/installing/linux.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> --- doc/source/getting-started/installing/linux.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/source/getting-started/installing/linux.rst b/doc/source/getting-started/installing/linux.rst index ea815622..954d080a 100644 --- a/doc/source/getting-started/installing/linux.rst +++ b/doc/source/getting-started/installing/linux.rst @@ -5,8 +5,8 @@ This page explains how to install PyWorkbench locally on a Linux platform. .. note:: - The following instructions assume that you have a local installation of Workbench and a valid - license in your machine. + The following instructions assume that you have a local installation of Workbench with a + valid license. There are two ways to install PyWorkbench on Linux: From b1dd0dff9899976c7514dd3b544ffa0871780564 Mon Sep 17 00:00:00 2001 From: Revathy Venugopal <104772255+Revathyvenugopal162@users.noreply.github.com> Date: Thu, 12 Jun 2025 17:41:14 +0200 Subject: [PATCH 7/7] Apply suggestions from code review Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> --- doc/source/getting-started/installing/linux.rst | 2 +- doc/source/getting-started/installing/windows.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/source/getting-started/installing/linux.rst b/doc/source/getting-started/installing/linux.rst index 954d080a..05dc0803 100644 --- a/doc/source/getting-started/installing/linux.rst +++ b/doc/source/getting-started/installing/linux.rst @@ -18,7 +18,7 @@ Install from PyPI ================== PyWorkbench is available on the `Python Package Index (PyPI) `_. -You can install PyWorkbench using the `pip `_ command: +You can install PyWorkbench using this `pip `_ command: .. code-block:: shell diff --git a/doc/source/getting-started/installing/windows.rst b/doc/source/getting-started/installing/windows.rst index 5daf7634..5a8c0f5f 100644 --- a/doc/source/getting-started/installing/windows.rst +++ b/doc/source/getting-started/installing/windows.rst @@ -17,7 +17,7 @@ Install from PyPI ================== PyWorkbench is available on the `Python Package Index (PyPI) `_. -You can install PyWorkbench using the `pip `_ command: +You can install PyWorkbench using this `pip `_ command: .. code-block:: shell