Merge branch 'main' into fix/qk7

.gitignore

@@ -189,13 +189,8 @@ cython_debug/
 
 # End of https://www.toptal.com/developers/gitignore/api/python
 
-doc/source/examples/gallery_examples/*.rst
-doc/source/examples/gallery_examples/*/*.ipynb
-doc/source/examples/gallery_examples/*/*.py
-doc/source/examples/gallery_examples/*/*.md5
-doc/source/examples/gallery_examples/*/*.rst
-doc/source/examples/gallery_examples/*/*.pickle
-doc/source/examples/gallery_examples/**/*.png
+doc/source/examples/gallery_examples/**
+
 doc/source/sg_execution_times.rst
 
 # Ignore everything in the doc/source/api/ directory

doc/changelog.d/829.added.md

@@ -0,0 +1 @@
+DOC: Update known issues and limitations

doc/changelog.d/831.miscellaneous.md

@@ -0,0 +1 @@
+DOC: Add documentation for ``launch_mechanical``

doc/source/kil/mechanical.rst

@@ -20,7 +20,8 @@ Known issues and limitations
 - Mechanical is not thread safe.
 - Spaceclaim geometry (.scdocx) can not be imported on Linux platform.
 - On Linux based platforms, Ansys Motion and LSDYNA analysis support are limited.
-
+- A fatal error currently exists when you are shutting down Mechanical on the
+  Linux platform using Embedding (`#85 <https://github.com/ansys/pymechanical/issues/85>`_).
 
 24R1
 ^^^^

doc/source/user_guide_session/index.rst

@@ -36,7 +36,23 @@ Here is how you use the `launch_mechanical()`_ method to launch Mechanical from
 
     mechanical = launch_mechanical()
 
-When Mechanical is active, you can send commands to it as a genuine
+If multiple versions of product are installed, then you can use ``exec_file`` argument
+to select the version of the product to launch.
+
+.. code:: python
+
+    exec_file_path = "C:/Program Files/ANSYS Inc/v242/aisol/bin/win64/AnsysWBU.exe"
+    mechanical = launch_mechanical(
+        exec_file=exec_file_path, batch=False, cleanup_on_exit=False
+    )
+
+If ``batch`` option is set ``True`` the Mechanical launches without GUI. The ``cleanup_on_exit``
+option decides whether product exits at the end of the PyMechanical script or not.
+
+.. note::
+   ``version`` argument is used only if PyPIM is configured. For general cases, use ``exec_file``
+
+You can send genuine Python class commands to the application when Mechanical is active.
 Python class. For example, you can send a Python script:
 
 .. code:: python