From e0e2c2e2603ca22bd82c95102f9dd9e061dbce11 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 29 Apr 2024 17:32:48 +0200 Subject: [PATCH 1/4] Bump pyvista[jupyter] from 0.43.4 to 0.43.6 in /requirements (#238) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- requirements/requirements_doc.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements/requirements_doc.txt b/requirements/requirements_doc.txt index 61e093e6..2fa3b196 100644 --- a/requirements/requirements_doc.txt +++ b/requirements/requirements_doc.txt @@ -5,7 +5,7 @@ nest-asyncio==1.6.0 pandas==2.2.2 plotly==5.20.0 pythreejs==2.4.2 -pyvista[jupyter]==0.43.4 +pyvista[jupyter]==0.43.6 vtk==9.3.0 # Documentation dependencies From 644c20c867e36d19bba8102af282e40889492ae0 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 29 Apr 2024 15:39:25 +0000 Subject: [PATCH 2/4] Bump panel from 1.3.8 to 1.4.2 in /requirements (#237) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- requirements/requirements_doc.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements/requirements_doc.txt b/requirements/requirements_doc.txt index 2fa3b196..f5b534b7 100644 --- a/requirements/requirements_doc.txt +++ b/requirements/requirements_doc.txt @@ -20,5 +20,5 @@ sphinx-gallery==0.15.0 sphinx-autobuild==2024.2.4 sphinx-autodoc-typehints==2.0.0 sphinx-notfound-page==1.0.0 -panel==1.3.8 +panel==1.4.2 pypandoc==1.13 From 32da53c6f1391b5e4909eae5ee6022066c234456 Mon Sep 17 00:00:00 2001 From: Camille <78221213+clatapie@users.noreply.github.com> Date: Mon, 29 Apr 2024 15:48:06 +0000 Subject: [PATCH 3/4] feat: using pyvista.DynamicScrapper (#226) --- .github/workflows/ci_cd.yml | 3 ++- .gitignore | 11 ++++++----- doc/source/conf.py | 5 ++++- requirements/requirements_doc.txt | 1 + 4 files changed, 13 insertions(+), 7 deletions(-) diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml index 868d657a..00396f14 100644 --- a/.github/workflows/ci_cd.yml +++ b/.github/workflows/ci_cd.yml @@ -161,6 +161,7 @@ jobs: skip-install: true sphinxopts: -j auto -W --keep-going use-python-cache: False + check-links: False - name: "Deploy" if: contains(github.ref, 'refs/heads/main') @@ -216,7 +217,7 @@ jobs: if compgen -G './logs-build-docs/*.out' > /dev/null ;then for f in ./logs-build-docs/*.out; do echo "::group:: Output file $f" && cat $f && echo "::endgroup::" ; done; fi release: - if: github.event_name == 'push' && contains(github.ref, 'refs/tags') + if: github.event_name == 'refs/heads/main' && !contains(github.ref, 'refs/tags') needs: [style, doc-build] #docs-style runs-on: ubuntu-latest steps: diff --git a/.gitignore b/.gitignore index 155f5b82..0b8ccf38 100644 --- a/.gitignore +++ b/.gitignore @@ -158,8 +158,9 @@ cython_debug/ # End of https://www.toptal.com/developers/gitignore/api/python -PyMAPDL_Dev -doc/source/technology_showcase_examples/*.ipynb -doc/source/technology_showcase_examples/*.py -doc/source/technology_showcase_examples/*.md5 -doc/source/technology_showcase_examples/*.pickle \ No newline at end of file +# PyMAPDL_Dev +doc/source/technology_showcase_examples/*.ipynb +doc/source/technology_showcase_examples/*.py +doc/source/technology_showcase_examples/*.md5 +doc/source/technology_showcase_examples/*.pickle +sg_execution_times.rst \ No newline at end of file diff --git a/doc/source/conf.py b/doc/source/conf.py index 24e7f641..8ef9c77c 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -7,6 +7,7 @@ from ansys_sphinx_theme import pyansys_logo_black as logo import numpy as np import pyvista +from pyvista.plotting.utilities.sphinx_gallery import DynamicScraper from sphinx_gallery.sorting import FileNameSortKey # Project information @@ -68,9 +69,11 @@ "jupyter_sphinx", "notfound.extension", "numpydoc", + "pyvista.ext.viewer_directive", "sphinx.ext.autodoc", "sphinx.ext.autosummary", "sphinx.ext.coverage", + "sphinx_design", "sphinx.ext.doctest", "sphinx.ext.extlinks", "sphinx.ext.intersphinx", @@ -97,7 +100,7 @@ "backreferences_dir": None, # Modules for which function level galleries are created. In "doc_module": "ansys-mapdl-core", - "image_scrapers": ("pyvista", "matplotlib"), + "image_scrapers": (DynamicScraper(), "matplotlib"), "ignore_pattern": "flycheck*", "thumbnail_size": (350, 350), } diff --git a/requirements/requirements_doc.txt b/requirements/requirements_doc.txt index f5b534b7..bd498c11 100644 --- a/requirements/requirements_doc.txt +++ b/requirements/requirements_doc.txt @@ -19,6 +19,7 @@ sphinxemoji==0.3.1 sphinx-gallery==0.15.0 sphinx-autobuild==2024.2.4 sphinx-autodoc-typehints==2.0.0 +sphinx-design==0.5.0 sphinx-notfound-page==1.0.0 panel==1.4.2 pypandoc==1.13 From fe39ab0b0ed68183270c116c261263b99cdbe6d0 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 29 Apr 2024 18:10:09 +0200 Subject: [PATCH 4/4] Bump ansys/actions from 5 to 6 (#235) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/ci_cd.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml index 00396f14..933d6b2c 100644 --- a/.github/workflows/ci_cd.yml +++ b/.github/workflows/ci_cd.yml @@ -153,7 +153,7 @@ jobs: .ci/waiting_services.sh - name: "Run Ansys documentation building action" - uses: ansys/actions/doc-build@v5 + uses: ansys/actions/doc-build@v6 with: requires-xvfb: true python-version: ${{ env.MAIN_PYTHON_VERSION }}