docs: only use wheelhouses for all dependencies (#887)

Co-authored-by: pyansys-ci-bot <[email protected]>

Author: duposyl

.github/workflows/ci_cd_night.yml

@@ -19,10 +19,8 @@ on:
     # From Monday to Friday (both included) at 00:00 UTC. Used for running only
     # the 'MAIN_PYTHON_VERSION'.
     - cron: '0 0 * * 1-5'
-    # From Saturday to Sunday (both included) at 00:00 UTC. Used for running the
-    # complete list of Python versions.
     - cron: '0 0 * * 6,0'
-
+      # From Saturday to Sunday (both included) at 00:00 UTC. Used for running the
 env:
   ANSYS_STK: 'ansys-stk'
   DOCUMENTATION_CNAME: 'stk.docs.pyansys.com'
@@ -58,7 +56,7 @@ jobs:
       matrix:
         os: [ubuntu-latest, windows-latest]
         python-version: ['3.10', '3.11', '3.12', '3.13']
-        target: ['core', 'extensions', 'grpc', 'jupyter', 'migration', 'all']
+        target: ['all']
     steps:
       - uses: ansys/actions/build-wheelhouse@21c9de9bee9692173780696d4a39964f20b9cfa3 # v10.1.5
         with:
@@ -248,9 +246,9 @@ jobs:
             "${STK_CONTAINER}" /bin/bash -c \
             "python -m pip install --group tests ."
 
-      # -- Tests
-
       - name: "Run the extensions tests"
+        # -- Tests
+
         env:
           STK_CONTAINER: ${{ steps.docker.outputs.container }}
         run: |
@@ -313,9 +311,9 @@ jobs:
             "${STK_CONTAINER}" /bin/bash -c \
             "export COVERAGE_FILE=.cov/snippets && tox -e tests-core-snippets-graphics-cov-linux"
 
-      # -- Coverage
-
       - name: "Combine all coverage results"
+        # -- Coverage
+
         if: ${{ matrix.python == env.MINIMUM_PYTHON_VERSION }}
         env:
           STK_CONTAINER: ${{ steps.docker.outputs.container }}

.github/workflows/ci_cd_pr.yml

@@ -170,7 +170,7 @@ jobs:
       matrix:
         os: [ubuntu-latest, windows-latest]
         python-version: ['3.10', '3.11', '3.12', '3.13']
-        target: ['core', 'extensions', 'grpc', 'jupyter', 'migration', 'all']
+        target: ['all']
     steps:
       - uses: ansys/actions/build-wheelhouse@21c9de9bee9692173780696d4a39964f20b9cfa3 # v10.1.5
         with:
@@ -301,10 +301,10 @@ jobs:
             python -m pip install --upgrade pip tox && rm -rf .tox
           fi
 
-      # Render the documentation including or excluding different sections
-      # according to the labels of the pull-request.
-
       - name: "Build docs including the 'Examples' section"
+        # Render the documentation including or excluding different sections
+        # according to the labels of the pull-request.
+
         id: build-doc-with-examples
         if: |
           contains(github.event.pull_request.labels.*.name, 'docs:examples') &&
@@ -351,11 +351,11 @@ jobs:
             "${STK_CONTAINER}" /bin/bash -c \
             "export BUILD_API=true BUILD_EXAMPLES=true && tox -e doc-clean,doc-links,doc-html"
 
-      # If required, combine partially rendered documentation with the nightly
-      # build artifacts. Upload the generated documentation as an artifact in
-      # the CI/CD session.
-
       - name: "Download latest API docs"
+        # If required, combine partially rendered documentation with the nightly
+        # the CI/CD session.
+
+        # build artifacts. Upload the generated documentation as an artifact in
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         if: steps.build-doc-full.outcome == 'skipped'
         with:
@@ -536,9 +536,9 @@ jobs:
             "${STK_CONTAINER}" /bin/bash -c \
             "export COVERAGE_FILE=.cov/snippets && tox -e tests-core-snippets-graphics-cov-linux"
 
-      # -- Coverage
-
       - name: "Combine all coverage results"
+        # -- Coverage
+
         if: ${{ matrix.python == env.MINIMUM_PYTHON_VERSION }}
         env:
           STK_CONTAINER: ${{ steps.docker.outputs.container }}

.github/workflows/ci_cd_release.yml

@@ -103,7 +103,7 @@ jobs:
       matrix:
         os: [ubuntu-latest, windows-latest]
         python-version: ['3.10', '3.11', '3.12', '3.13']
-        target: ['core', 'extensions', 'grpc', 'jupyter', 'migration', 'all']
+        target: ['all']
     steps:
       - uses: ansys/actions/build-wheelhouse@21c9de9bee9692173780696d4a39964f20b9cfa3 # v10.1.5
         with:
@@ -282,9 +282,9 @@ jobs:
             "${STK_CONTAINER}" /bin/bash -c \
             "python -m pip install --group tests ."
 
-      # -- Tests
-
       - name: "Run the extensions tests"
+        # -- Tests
+
         env:
           STK_CONTAINER: ${{ steps.docker.outputs.container }}
         run: |
@@ -347,9 +347,9 @@ jobs:
             "${STK_CONTAINER}" /bin/bash -c \
             "export COVERAGE_FILE=.cov/snippets && tox -e tests-core-snippets-graphics-cov-linux"
 
-      # -- Coverage
-
       - name: "Combine all coverage results"
+        # -- Coverage
+
         if: ${{ matrix.python == env.MINIMUM_PYTHON_VERSION }}
         env:
           STK_CONTAINER: ${{ steps.docker.outputs.container }}

doc/source/artifacts.rst

@@ -5,12 +5,17 @@ This topic assists you in downloading the different artifacts generated by the b
 process. These artifacts include wheels, source tarballs, and documentation
 files in various formats.
 
+.. seealso::
+
+    :doc:`Installation instructions <getting-started/install>`.
+
 Required artifacts
 ==================
 
 These artifacts include the minimum software required for installing PySTK.
 Extra dependencies for visualization in IPython or performing data-analysis
-are not included.
+are not included. Those extra dependencies must be pulled separately
+from PyPI if needed.
 
 .. jinja:: artifacts
 
@@ -27,23 +32,17 @@ are not included.
           - `{{ source }} <_static/artifacts/{{ source }}>`_
         {% endfor %}
 
-Extra artifacts
-===============
-
-These artifacts include additional dependencies required for using some
-features, like gRPC connections, Jupyter widgets, and data-analysis.
-
 All extra artifacts
--------------------
+===================
 
-These extra artifacts include all the dependencies for using any additional
-features:
+These artifacts include all dependencies required by all the
+features, like gRPC connections, Jupyter widgets, and data-analysis.
 
 .. jinja:: wheelhouse
 
     .. csv-table::
        :header-rows: 1
-       :widths: 16, 28, 28, 28
+       :widths: 16, 21, 21, 21, 21
 
        :fas:`laptop` Platform,
        {%- for python in SUPPORTED_PYTHON_VERSIONS -%}
@@ -57,103 +56,3 @@ features:
        {%- if not loop.last -%},{%- endif -%}
        {% endfor %}
        {% endfor %}
-
-Extensions
-----------
-
-These extra artifacts provide a set of high-level workflows for automating
-common tasks with PySTK.
-
-.. jinja:: wheelhouse
-
-    .. csv-table::
-       :header-rows: 1
-       :widths: 16, 28, 28, 28
-
-       :fas:`laptop` Platform,
-       {%- for python in SUPPORTED_PYTHON_VERSIONS -%}
-       :fab:`python` Python {{ python }}
-       {%- if not loop.last -%},{%- endif -%}
-       {% endfor %}
-       {% for platform in SUPPORTED_PLATFORMS -%}
-       :fab:`{{ platform }}` {{ platform | capitalize }},
-       {%- for python in SUPPORTED_PYTHON_VERSIONS -%}
-       `Download wheelhouse <{{ wheelhouse[platform][python]["extensions"] }}/{{ wheelhouse[platform][python]["extensions"].name }}.zip>`__
-       {%- if not loop.last -%},{%- endif -%}
-       {% endfor %}
-       {% endfor %}
-
-gRPC
-----
-
-These extra artifacts include all the dependencies for using gRPC connections.
-
-.. jinja:: wheelhouse
-
-    .. csv-table::
-       :header-rows: 1
-       :widths: 16, 28, 28, 28
-
-       :fas:`laptop` Platform,
-       {%- for python in SUPPORTED_PYTHON_VERSIONS -%}
-       :fab:`python` Python {{ python }}
-       {%- if not loop.last -%},{%- endif -%}
-       {% endfor %}
-       {% for platform in SUPPORTED_PLATFORMS -%}
-       :fab:`{{ platform }}` {{ platform | capitalize }},
-       {%- for python in SUPPORTED_PYTHON_VERSIONS -%}
-       `Download wheelhouse <{{ wheelhouse[platform][python]["grpc"] }}/{{ wheelhouse[platform][python]["grpc"].name }}.zip>`__
-       {%- if not loop.last -%},{%- endif -%}
-       {% endfor %}
-       {% endfor %}
-
-Jupyter
--------
-
-These extra artifacts include all the dependencies for using interactive
-visualization widgets within IPython environments, such as Jupyter Lab.
-
-.. jinja:: wheelhouse
-
-    .. csv-table::
-       :header-rows: 1
-       :widths: 16, 28, 28, 28
-
-       :fas:`laptop` Platform,
-       {%- for python in SUPPORTED_PYTHON_VERSIONS -%}
-       :fab:`python` Python {{ python }}
-       {%- if not loop.last -%},{%- endif -%}
-       {% endfor %}
-       {% for platform in SUPPORTED_PLATFORMS -%}
-       :fab:`{{ platform }}` {{ platform | capitalize }},
-       {%- for python in SUPPORTED_PYTHON_VERSIONS -%}
-       `Download wheelhouse <{{ wheelhouse[platform][python]["jupyter"] }}/{{ wheelhouse[platform][python]["jupyter"].name }}.zip>`__
-       {%- if not loop.last -%},{%- endif -%}
-       {% endfor %}
-       {% endfor %}
-
-Migration
----------
-
-These extra artifacts include all the dependencies for migrating your existing
-Python code to PySTK. See the :ref:`migration guide <Migrate to PySTK>`.
-
-.. jinja:: wheelhouse
-
-    .. csv-table::
-       :header-rows: 1
-       :widths: 16, 28, 28, 28
-
-       :fas:`laptop` Platform,
-       {%- for python in SUPPORTED_PYTHON_VERSIONS -%}
-       :fab:`python` Python {{ python }}
-       {%- if not loop.last -%},{%- endif -%}
-       {% endfor %}
-       {% for platform in SUPPORTED_PLATFORMS -%}
-       :fab:`{{ platform }}` {{ platform | capitalize }},
-       {%- for python in SUPPORTED_PYTHON_VERSIONS -%}
-       `Download wheelhouse <{{ wheelhouse[platform][python]["migration"] }}/{{ wheelhouse[platform][python]["migration"].name }}.zip>`__
-       {%- if not loop.last -%},{%- endif -%}
-       {% endfor %}
-       {% endfor %}
-

doc/source/changelog/887.documentation.md

@@ -0,0 +1 @@
+Only use wheelhouses for all dependencies

doc/source/conf.py

@@ -371,7 +371,7 @@ def read_optional_dependencies_from_pyproject():
 
 
 jinja_globals = {
-    "SUPPORTED_PYTHON_VERSIONS": ["3.11", "3.12", "3.13"],
+    "SUPPORTED_PYTHON_VERSIONS": ["3.10", "3.11", "3.12", "3.13"],
     "SUPPORTED_PLATFORMS": ["windows", "ubuntu"],
     "PYSTK_VERSION": version,
     "STK_VERSION": "13.0.0",