fix: Local launcher fixes

.gitignore

@@ -131,7 +131,7 @@ celerybeat.pid
 .env
 .venv
 env/
-venv/
+*venv/
 ENV/
 env.bak/
 venv.bak/

doc/Makefile

@@ -5,7 +5,7 @@
 SPHINXOPTS    = -j auto -W --color
 SPHINXBUILD   = sphinx-build
 APIDIR        = api
-EXAMPLESDIR        = examples
+EXAMPLESDIR   = examples
 SOURCEDIR     = source
 BUILDDIR      = _build
 

doc/source/changelog/118.documentation.md

@@ -0,0 +1 @@
+Fix: Local launcher fixes

doc/source/conf.py

@@ -82,8 +82,33 @@
     "sphinx_design",
     "ansys_sphinx_theme.extension.autoapi",
     "sphinx_click",  # Required by local-product-launcher
+    "sphinx_gallery.gen_gallery",
+    "sphinx_jinja",
 ]
 
+# sphinx gallery options
+sphinx_gallery_conf = {
+    # path to your examples scripts
+    "examples_dirs": ["../../examples"],
+    # path where to save gallery generated examples
+    "gallery_dirs": ["examples"],
+    # Pattern to search for example files
+    "filename_pattern": r"\.py",
+    # Remove the "Download all examples" button from the top level gallery
+    "download_all_examples": False,
+    # Sort gallery example by file name instead of number of lines (default)
+    "within_subsection_order": "FileNameSortKey",
+    # directory where function granular galleries are stored
+    "backreferences_dir": None,
+    # Modules for which function level galleries are created.  In
+    "doc_module": "ansys-tools-common",
+    "image_scrapers": ("matplotlib",),
+    "ignore_pattern": r"__init__\.py",
+    "thumbnail_size": (350, 350),
+    "copyfile_regex": r".*\.rst",
+}
+
+
 # numpydoc configuration
 numpydoc_show_class_members = False
 numpydoc_xref_param_type = True

doc/source/examples/index.rst

@@ -0,0 +1,53 @@
+:orphan:
+
+Examples
+========
+
+This section shows how to use the local launcher.
+
+
+.. raw:: html
+
+    <div class="sphx-glr-thumbnails">
+
+.. thumbnail-parent-div-open
+
+.. thumbnail-parent-div-close
+
+.. raw:: html
+
+    </div>
+
+Examples
+========
+
+This section shows how to use the local launcher tool.
+
+
+.. raw:: html
+
+    <div class="sphx-glr-thumbnails">
+
+.. thumbnail-parent-div-open
+
+.. thumbnail-parent-div-close
+
+.. raw:: html
+
+    </div>
+
+
+.. toctree::
+   :hidden:
+   :includehidden:
+
+
+   /examples/local_launcher/index.rst
+
+
+
+.. only:: html
+
+ .. rst-class:: sphx-glr-signature
+
+    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_

doc/source/examples/local_launcher/index.rst

@@ -0,0 +1,22 @@
+
+
+.. _sphx_glr_examples_local_launcher:
+
+Examples
+========
+
+This section shows how to use the local launcher tool.
+
+
+.. raw:: html
+
+    <div class="sphx-glr-thumbnails">
+
+.. thumbnail-parent-div-open
+
+.. thumbnail-parent-div-close
+
+.. raw:: html
+
+    </div>
+

doc/source/examples/local_launcher/sg_execution_times.rst

@@ -0,0 +1,37 @@
+
+:orphan:
+
+.. _sphx_glr_examples_local_launcher_sg_execution_times:
+
+
+Computation times
+=================
+**00:00.000** total execution time for 0 files **from examples\local_launcher**:
+
+.. container::
+
+  .. raw:: html
+
+    <style scoped>
+    <link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/5.3.0/css/bootstrap.min.css" rel="stylesheet" />
+    <link href="https://cdn.datatables.net/1.13.6/css/dataTables.bootstrap5.min.css" rel="stylesheet" />
+    </style>
+    <script src="https://code.jquery.com/jquery-3.7.0.js"></script>
+    <script src="https://cdn.datatables.net/1.13.6/js/jquery.dataTables.min.js"></script>
+    <script src="https://cdn.datatables.net/1.13.6/js/dataTables.bootstrap5.min.js"></script>
+    <script type="text/javascript" class="init">
+    $(document).ready( function () {
+        $('table.sg-datatable').DataTable({order: [[1, 'desc']]});
+    } );
+    </script>
+
+  .. list-table::
+   :header-rows: 1
+   :class: table table-striped sg-datatable
+
+   * - Example
+     - Time
+     - Mem (MB)
+   * - N/A
+     - N/A
+     - N/A

doc/source/examples/sg_execution_times.rst

@@ -0,0 +1,37 @@
+
+:orphan:
+
+.. _sphx_glr_examples_sg_execution_times:
+
+
+Computation times
+=================
+**00:00.000** total execution time for 0 files **from examples**:
+
+.. container::
+
+  .. raw:: html
+
+    <style scoped>
+    <link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/5.3.0/css/bootstrap.min.css" rel="stylesheet" />
+    <link href="https://cdn.datatables.net/1.13.6/css/dataTables.bootstrap5.min.css" rel="stylesheet" />
+    </style>
+    <script src="https://code.jquery.com/jquery-3.7.0.js"></script>
+    <script src="https://cdn.datatables.net/1.13.6/js/jquery.dataTables.min.js"></script>
+    <script src="https://cdn.datatables.net/1.13.6/js/dataTables.bootstrap5.min.js"></script>
+    <script type="text/javascript" class="init">
+    $(document).ready( function () {
+        $('table.sg-datatable').DataTable({order: [[1, 'desc']]});
+    } );
+    </script>
+
+  .. list-table::
+   :header-rows: 1
+   :class: table table-striped sg-datatable
+
+   * - Example
+     - Time
+     - Mem (MB)
+   * - N/A
+     - N/A
+     - N/A

doc/source/index.rst

@@ -31,6 +31,13 @@ Ansys Common Tools provides a collection of tools for the PyAnsys ecosystem.
 
         Understand how to use Python to interact programmatically with the tools.
 
+    .. grid-item-card:: Examples :material-regular:`play_arrow`
+        :padding: 2 2 2 2
+        :link: examples/index
+        :link-type: doc
+
+        Explore examples that show how to use the different tools in practice.
+
     .. grid-item-card:: Contribute :material-regular:`group`
         :padding: 2 2 2 2
         :link: contributing
@@ -40,12 +47,14 @@ Ansys Common Tools provides a collection of tools for the PyAnsys ecosystem.
 
 
 
+
 .. toctree::
     :hidden:
     :maxdepth: 3
 
     getting_started/index
     user_guide/index
     api/index
+    examples/index
     contributing
     changelog

doc/source/sg_execution_times.rst

@@ -0,0 +1,37 @@
+
+:orphan:
+
+.. _sphx_glr_sg_execution_times:
+
+
+Computation times
+=================
+**00:00.000** total execution time for 0 files **from all galleries**:
+
+.. container::
+
+  .. raw:: html
+
+    <style scoped>
+    <link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/5.3.0/css/bootstrap.min.css" rel="stylesheet" />
+    <link href="https://cdn.datatables.net/1.13.6/css/dataTables.bootstrap5.min.css" rel="stylesheet" />
+    </style>
+    <script src="https://code.jquery.com/jquery-3.7.0.js"></script>
+    <script src="https://cdn.datatables.net/1.13.6/js/jquery.dataTables.min.js"></script>
+    <script src="https://cdn.datatables.net/1.13.6/js/dataTables.bootstrap5.min.js"></script>
+    <script type="text/javascript" class="init">
+    $(document).ready( function () {
+        $('table.sg-datatable').DataTable({order: [[1, 'desc']]});
+    } );
+    </script>
+
+  .. list-table::
+   :header-rows: 1
+   :class: table table-striped sg-datatable
+
+   * - Example
+     - Time
+     - Mem (MB)
+   * - N/A
+     - N/A
+     - N/A

examples/README.txt

@@ -0,0 +1,4 @@
+Examples
+========
+
+This section shows how to use the local launcher.

examples/local_launcher/README.txt

@@ -0,0 +1,4 @@
+Examples
+========
+
+This section shows how to use the local launcher tool.

examples/local_launcher/example_httpserver_plugin/pyproject.toml

@@ -0,0 +1,20 @@
+[build-system]
+build-backend = "flit_core.buildapi"
+requires = [ "flit-core>=3.2,<4" ]
+
+[project]
+name = "example-httpserver-plugin"
+authors = [ { name = "ANSYS, Inc.", email = "[email protected]" } ]
+classifiers = [
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+]
+dynamic = [ "description", "version" ]
+dependencies = [ "ansys-tools-local-product-launcher", "requests" ]
+
+entry-points."ansys.tools.local_product_launcher.launcher"."example_httpserver.__fallback__" = "example_httpserver_plugin:Launcher"
+entry-points."ansys.tools.local_product_launcher.launcher"."example_httpserver.direct" = "example_httpserver_plugin:Launcher"

examples/local_launcher/example_httpserver_plugin/src/example_httpserver_plugin/__init__.py

@@ -0,0 +1,28 @@
+# Copyright (C) 2025 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+"""Example plugin for ansys-tools-local-product-launcher."""
+
+from .launcher import Launcher, LauncherConfig
+
+__version__ = "0.1.0"
+__all__ = ["LauncherConfig", "Launcher"]