chore: graphics target (#820)

* chore: graphics target

* fix: try fixing doc gen error

* fix: send error to stdout

* retro: compatibility

* fix: revert

---------

Co-authored-by: Paul Profizi <[email protected]>

Author: moe-ad

.github/workflows/ci.yml

@@ -101,7 +101,7 @@ jobs:
           PACKAGE_NAME: ${{env.PACKAGE_NAME}}
           MODULE: ${{env.MODULE}}
           dpf-standalone-TOKEN: ${{secrets.DPF_PIPELINE}}
-          install_extras: plotting
+          install_extras: graphics
           # Upload the wheel artifact for only one of the OS as it is OS-agnostic
           wheel: ${{ (matrix.python-version == env.MAIN_PYTHON_VERSION) && (matrix.os == 'windows-latest') }}
           wheelhouse: true
@@ -172,7 +172,7 @@ jobs:
           PACKAGE_NAME: ${{env.PACKAGE_NAME}}
           MODULE: ${{env.MODULE}}
           dpf-standalone-TOKEN: ${{secrets.DPF_PIPELINE}}
-          install_extras: plotting
+          install_extras: graphics
           wheel: false
           standalone_suffix: ${{ matrix.ANSYS_VERSION == '241' && '.sp01' || '' }}
 

.github/workflows/ci_release.yml

@@ -84,7 +84,7 @@ jobs:
           PACKAGE_NAME: ${{env.PACKAGE_NAME}}
           MODULE: ${{env.MODULE}}
           dpf-standalone-TOKEN: ${{secrets.DPF_PIPELINE}}
-          install_extras: plotting
+          install_extras: graphics
           # Upload the wheel artifact for only one of the OS as it is OS-agnostic
           wheel: ${{ (matrix.python-version == env.MAIN_PYTHON_VERSION) && (matrix.os == 'windows-latest') }}
           wheelhouse: true
@@ -153,7 +153,7 @@ jobs:
           PACKAGE_NAME: ${{env.PACKAGE_NAME}}
           MODULE: ${{env.MODULE}}
           dpf-standalone-TOKEN: ${{secrets.DPF_PIPELINE}}
-          install_extras: plotting
+          install_extras: graphics
           wheel: false
           extra-pip-args: ${{ env.extra }}
 

.github/workflows/docs.yml

@@ -100,7 +100,7 @@ jobs:
           PACKAGE_NAME: ${{env.PACKAGE_NAME}}
           MODULE: ${{env.MODULE}}
           dpf-standalone-TOKEN: ${{secrets.DPF_PIPELINE}}
-          install_extras: plotting
+          install_extras: graphics
           wheel: false
           wheelhouse: false
           standalone_suffix: ${{ inputs.standalone_suffix }}
@@ -130,6 +130,7 @@ jobs:
           export TEMP=${{ runner.temp }}
           make clean
           echo "Making html doc..."
+          make html
           make html $DEBUG_HTML >> log.txt 2>&1
 
       - name: "Check for success"

.github/workflows/examples.yml

@@ -84,7 +84,7 @@ jobs:
           PACKAGE_NAME: ${{ env.PACKAGE_NAME }}
           MODULE: ${{ env.MODULE }}
           dpf-standalone-TOKEN: ${{secrets.DPF_PIPELINE}}
-          install_extras: plotting
+          install_extras: graphics
           wheelhouse: false
           wheel: false
           standalone_suffix: ${{ inputs.standalone_suffix }}

doc/source/getting_started/install.rst

@@ -31,7 +31,13 @@ To install PyDPF-Post with its optional plotting functionalities, use this comma
 
 .. code:: bash
 
-   pip install ansys-dpf-post[plotting]
+   pip install ansys-dpf-post[graphics]
+
+.. warning::
+
+   ``pip install ansys-dpf-post[plotting]`` is equivalent to the previous command, however, the "plotting" target
+   only remains valid for legacy reasons and will soon be deprecated. Users are encouraged to use the "graphics"
+   target instead.
 
 For more information about PyDPF-Post plotting capabilities, see :ref:`user_guide_plotting`.
 

pyproject.toml

@@ -41,6 +41,10 @@ name = "ansys.dpf.post"
 Source = "https://github.com/ansys/pydpf-post"
 
 [project.optional-dependencies]
+graphics = [
+    "pyvista>=0.24.0",
+]
+
 plotting = [
     "pyvista>=0.24.0",
 ]

requirements/requirements_docs.txt

@@ -9,7 +9,7 @@ pytest-sphinx==0.6.3
 sphinx-notfound-page==1.1.0
 sphinx-copybutton==0.5.0
 sphinx-gallery==0.19.0
-ansys_sphinx_theme==1.3.3
+ansys_sphinx_theme==1.4.1
 sphinx-autodoc-typehints==3.0.1
 pyvista==0.45.2
 vtk==9.3.1