From af7fa1936bab7f418757907b4d13528b818c1cc0 Mon Sep 17 00:00:00 2001
From: Dominik Gresch <dominik.gresch@ansys.com>
Date: Wed, 27 Nov 2024 00:04:37 +0100
Subject: [PATCH] Doc: add link to the Ansys Help Composites page

Add a link to the main Composites page in the Ansys Help as
a grid item card on the main page of the documentation.

The reason for linking this page instead of a more specific page
is that it is the only one where I could easily figure out how
to link to a page that does not change URL with every release.
---
 doc/source/conf.py   | 16 ++++++++++------
 doc/source/index.rst |  6 ++++++
 2 files changed, 16 insertions(+), 6 deletions(-)

diff --git a/doc/source/conf.py b/doc/source/conf.py
index a93f1bbdfa..ef8f70dc0c 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -111,15 +111,19 @@ def _signature(
 
 SKIP_GALLERY = os.environ.get("PYACP_DOC_SKIP_GALLERY", "0").lower() in ("1", "true")
 SKIP_API = os.environ.get("PYACP_DOC_SKIP_API", "0").lower() in ("1", "true")
+SOURCE_DIR = pathlib.Path(__file__).parent
 
 # nested example index files are directly included in the parent index file
 exclude_patterns = ["examples/*/index.rst"]
 if SKIP_API:
-    # Exclude all API documentation except the index
-    # The 'api/!(index).rst' syntax does not appear to be supported by Sphinx
-    for file_path in pathlib.Path("api").glob("**/*.rst"):
-        if str(file_path) != "api/index.rst":
-            exclude_patterns.append(str(file_path))
+    # Exclude all API documentation except the top-level index file:
+    # Exclude files on the top level explicitly, except 'index.rst'
+    for file_path in (SOURCE_DIR / "api").iterdir():
+        if not file_path.name == "index.rst":
+            pattern = str(file_path.relative_to(SOURCE_DIR).as_posix())
+            exclude_patterns.append(pattern)
+    # Exclude all files in nested directories
+    exclude_patterns.append("api/**/*.rst")
 
 
 jinja_contexts = {
@@ -201,7 +205,7 @@ def _signature(
     # "pandas": ("https://pandas.pydata.org/pandas-docs/stable", None),
     "grpc": ("https://grpc.github.io/grpc/python/", None),
     "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None),
-    "pyvista": ("https://docs.pyvista.org/version/stable", None),
+    "pyvista": ("https://docs.pyvista.org/", None),
     "ansys-dpf-core": ("https://dpf.docs.pyansys.com/version/stable/", None),
     "ansys-dpf-composites": ("https://composites.dpf.docs.pyansys.com/version/stable/", None),
     "ansys-mechanical-core": ("https://mechanical.docs.pyansys.com/version/stable/", None),
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 680c30e994..86db66f7b2 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -70,6 +70,12 @@ optimization of composite structures.
 
             Information on how to contribute to PyACP.
 
+        .. grid-item-card:: :octicon:`mortar-board` ACP documentation
+            :link: https://ansyshelp.ansys.com/public/?returnurl=/Views/Secured/prod_page.html?pn=Composites&pid=CompositePrepPost
+            :columns: 12
+
+            Describes the modeling features and techniques of Ansys Composite PrepPost.
+
 
 .. _limitations: