diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 896b92126..b24fc4ea7 100644 --- a/.github/workflows/ci.yml +++ b/.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' || '' }} diff --git a/.github/workflows/ci_release.yml b/.github/workflows/ci_release.yml index 176eb8487..d39296c8c 100644 --- a/.github/workflows/ci_release.yml +++ b/.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 }} diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index e8aba6e55..7d5a09732 100644 --- a/.github/workflows/docs.yml +++ b/.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" diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml index db644d260..8d6cc2d18 100644 --- a/.github/workflows/examples.yml +++ b/.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 }} diff --git a/doc/source/getting_started/install.rst b/doc/source/getting_started/install.rst index f1c7005c7..a7874c0f9 100644 --- a/doc/source/getting_started/install.rst +++ b/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`. diff --git a/pyproject.toml b/pyproject.toml index 47fec8538..b96ae8547 100644 --- a/pyproject.toml +++ b/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", ] diff --git a/requirements/requirements_docs.txt b/requirements/requirements_docs.txt index 54410e343..2b748a635 100644 --- a/requirements/requirements_docs.txt +++ b/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