From 280f3fadfd7b24af5a096711209981d0c662a4e5 Mon Sep 17 00:00:00 2001 From: Paul Profizi <100710998+PProfizi@users.noreply.github.com> Date: Tue, 13 May 2025 10:42:38 +0200 Subject: [PATCH 1/6] ci(doc): build using Python 3.11 latest vtk dropped support for 3.10 --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 896b92126..45cc5b06a 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -219,7 +219,7 @@ jobs: uses: ./.github/workflows/docs.yml with: ANSYS_VERSION: "252" - python_version: "3.10" + python_version: "3.11" standalone_suffix: ${{ inputs.standalone_suffix || ''}} event_name: ${{ github.event_name }} secrets: inherit From fb0b0a7175a0987a432c9bf23c5db32503197db0 Mon Sep 17 00:00:00 2001 From: Paul Profizi <100710998+PProfizi@users.noreply.github.com> Date: Tue, 13 May 2025 10:43:29 +0200 Subject: [PATCH 2/6] Update ci_release.yml --- .github/workflows/ci_release.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci_release.yml b/.github/workflows/ci_release.yml index 176eb8487..53f40d62d 100644 --- a/.github/workflows/ci_release.yml +++ b/.github/workflows/ci_release.yml @@ -198,7 +198,7 @@ jobs: uses: ./.github/workflows/docs.yml with: ANSYS_VERSION: '251' - python_version: "3.10" + python_version: "3.11" standalone_suffix: ${{ github.event.inputs.standalone_branch_suffix || '' }} event_name: ${{ github.event_name }} secrets: inherit From d3053dd8eb43db86a89217097774498ad6ec01e1 Mon Sep 17 00:00:00 2001 From: Paul Profizi <100710998+PProfizi@users.noreply.github.com> Date: Tue, 13 May 2025 10:43:50 +0200 Subject: [PATCH 3/6] Update docs.yml --- .github/workflows/docs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index e8aba6e55..1966742d7 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -7,7 +7,7 @@ on: python_version: required: false type: string - default: "3.10" + default: "3.11" ANSYS_VERSION: required: false type: string @@ -37,7 +37,7 @@ on: description: "Python interpreter" required: true type: string - default: "3.10" + default: "3.11" ANSYS_VERSION: description: "ANSYS version" required: true From 2c1bdcfb4ddecd3e0fa6a2849e7ba9cfa3b9d0c6 Mon Sep 17 00:00:00 2001 From: PProfizi Date: Tue, 13 May 2025 11:36:34 +0200 Subject: [PATCH 4/6] Fix docutils warnings and errors --- doc/source/getting_started/demo.rst | 2 +- doc/source/user_guide/plotting.rst | 2 +- examples/01-Detailed-Examples/05-mesh-exploration.py | 6 +++--- examples/05-Legacy/01-get_data_from_static_simulation.py | 2 +- examples/05-Legacy/04-harmonic-analysis.py | 4 ++-- examples/05-Legacy/05-transient-analysis.py | 4 ++-- examples/05-Legacy/07-result_keywords.py | 2 +- src/ansys/dpf/post/simulation.py | 2 +- src/ansys/dpf/post/vector.py | 2 +- 9 files changed, 13 insertions(+), 13 deletions(-) diff --git a/doc/source/getting_started/demo.rst b/doc/source/getting_started/demo.rst index 468a48e48..c5261c172 100644 --- a/doc/source/getting_started/demo.rst +++ b/doc/source/getting_started/demo.rst @@ -54,7 +54,7 @@ to extract and postprocess results: .. image:: ./../images/crankshaft_stress.png :align: center - :figwidth: 300pt + :width: 300pt 2021 R1 through 2022 R2 diff --git a/doc/source/user_guide/plotting.rst b/doc/source/user_guide/plotting.rst index 55cb2bfd6..0dd13fb87 100644 --- a/doc/source/user_guide/plotting.rst +++ b/doc/source/user_guide/plotting.rst @@ -38,7 +38,7 @@ This code shows how to plot the total deformation (norm of the displacement vect >>> displacement_norm.plot(screenshot="crankshaft_disp.png") .. image:: ./../images/crankshaft_disp.png - :align: leftcenter + :align: center :width: 300pt diff --git a/examples/01-Detailed-Examples/05-mesh-exploration.py b/examples/01-Detailed-Examples/05-mesh-exploration.py index 57ca9a231..0d30653be 100644 --- a/examples/01-Detailed-Examples/05-mesh-exploration.py +++ b/examples/01-Detailed-Examples/05-mesh-exploration.py @@ -58,7 +58,7 @@ ############################################################################### # Plot mesh -# ------------- +# --------- # Plot the mesh to view the bare mesh of the model. mesh.plot() @@ -103,7 +103,7 @@ ############################################################################### # Get elements -# -------- +# ------------ # Get a list of the elements. print(mesh.elements) @@ -244,7 +244,7 @@ meshes.plot(text="Mesh split") ############################################################################### -# Select a specific ``Mesh``object in the split mesh by index. +# Select a specific ``Mesh`` object in the split mesh by index. meshes[0].plot(text="First mesh in the split mesh") ############################################################################### diff --git a/examples/05-Legacy/01-get_data_from_static_simulation.py b/examples/05-Legacy/01-get_data_from_static_simulation.py index b5310cb8e..94744cc9c 100644 --- a/examples/05-Legacy/01-get_data_from_static_simulation.py +++ b/examples/05-Legacy/01-get_data_from_static_simulation.py @@ -78,7 +78,7 @@ ############################################################################### # Get stresses at only five nodes -# ------------------------------ +# ------------------------------- # Get stresses at only the first five nodes using their IDs. stress_nodes = simulation.stress_nodal(node_ids=range(1, 6)) diff --git a/examples/05-Legacy/04-harmonic-analysis.py b/examples/05-Legacy/04-harmonic-analysis.py index 1aeeb79e1..e239d167e 100644 --- a/examples/05-Legacy/04-harmonic-analysis.py +++ b/examples/05-Legacy/04-harmonic-analysis.py @@ -64,7 +64,7 @@ ############################################################################### # Get number of fields -# ~~~~~~~~~~~~~~~~~~~~~~ +# ~~~~~~~~~~~~~~~~~~~~ disp.num_fields @@ -149,7 +149,7 @@ ############################################################################### # Get elastic strain result -# ========================= +# ------------------------- # Get an elastic strain result that deals with phase. It contains a field for # real values and a field for imaginary values. diff --git a/examples/05-Legacy/05-transient-analysis.py b/examples/05-Legacy/05-transient-analysis.py index f6882e810..733d91a5c 100644 --- a/examples/05-Legacy/05-transient-analysis.py +++ b/examples/05-Legacy/05-transient-analysis.py @@ -60,7 +60,7 @@ ############################################################################### # Get number of fields -# ~~~~~~~~~~~~~~~~~~~~~~ +# ~~~~~~~~~~~~~~~~~~~~ disp.num_fields @@ -96,7 +96,7 @@ ############################################################################### # Get stress result for a tensor -# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ stress_result = solution.stress() stress = stress_result.tensor diff --git a/examples/05-Legacy/07-result_keywords.py b/examples/05-Legacy/07-result_keywords.py index 0bc1d7765..5c46a29c2 100644 --- a/examples/05-Legacy/07-result_keywords.py +++ b/examples/05-Legacy/07-result_keywords.py @@ -94,7 +94,7 @@ ############################################################################### # Get a subresult -# ~~~~~~~~~~~~~~ +# ~~~~~~~~~~~~~~~ disp_x = displacement_result.x diff --git a/src/ansys/dpf/post/simulation.py b/src/ansys/dpf/post/simulation.py index 63595cd8e..779f9f498 100644 --- a/src/ansys/dpf/post/simulation.py +++ b/src/ansys/dpf/post/simulation.py @@ -243,7 +243,7 @@ def plot( def active_selection(self) -> Union[Selection, None]: """Active selection used by default for result queries. - Returns a :object:`ansys.dpf.post.selection.Selection` object. + Returns a :class:`ansys.dpf.post.selection.Selection` object. Examples -------- diff --git a/src/ansys/dpf/post/vector.py b/src/ansys/dpf/post/vector.py index 8b79e7eb3..75e3f8b34 100644 --- a/src/ansys/dpf/post/vector.py +++ b/src/ansys/dpf/post/vector.py @@ -20,7 +20,7 @@ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE # SOFTWARE. -"""Module containing ``Result` subclasses for vectors.""" +"""Module containing ``Result`` subclasses for vectors.""" from ansys.dpf.core import Operator From 9f2ff0ae8c01c5100f5a957c4fc64e02189ad958 Mon Sep 17 00:00:00 2001 From: PProfizi Date: Tue, 13 May 2025 14:32:31 +0200 Subject: [PATCH 5/6] Add autoapi flag to ansys_sphinx_theme in requirements_docs.txt --- requirements/requirements_docs.txt | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/requirements/requirements_docs.txt b/requirements/requirements_docs.txt index 59e25c211..afabd59d9 100644 --- a/requirements/requirements_docs.txt +++ b/requirements/requirements_docs.txt @@ -1,16 +1,16 @@ -pypandoc==1.15 +ansys_sphinx_theme[autoapi]==1.3.3 imageio==2.37.0 -numpydoc==1.8.0 imageio-ffmpeg==0.6.0 -Sphinx==8.1.3 -sphinxcontrib-napoleon==0.7 -sphinxcontrib-websupport==2.0.0 +pypandoc==1.15 pytest-sphinx==0.6.3 -sphinx-notfound-page==1.1.0 +pyvista==0.44.2 +sphinx==8.1.3 +numpydoc==1.8.0 +sphinx-autodoc-typehints==3.0.1 sphinx-copybutton==0.5.0 sphinx-gallery==0.19.0 -ansys_sphinx_theme==1.3.3 -sphinx-autodoc-typehints==3.0.1 -pyvista==0.44.2 -vtk==9.3.1 +sphinx-notfound-page==1.1.0 sphinx-design===0.6.1 +sphinxcontrib-napoleon==0.7 +sphinxcontrib-websupport==2.0.0 +vtk==9.3.1 From e730feb9bd61bf8861eb2869a7429423525726cf Mon Sep 17 00:00:00 2001 From: PProfizi Date: Tue, 13 May 2025 14:51:54 +0200 Subject: [PATCH 6/6] Try bumps --- requirements/requirements_docs.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/requirements/requirements_docs.txt b/requirements/requirements_docs.txt index afabd59d9..b506e9ceb 100644 --- a/requirements/requirements_docs.txt +++ b/requirements/requirements_docs.txt @@ -1,11 +1,11 @@ ansys_sphinx_theme[autoapi]==1.3.3 imageio==2.37.0 imageio-ffmpeg==0.6.0 +numpydoc==1.8.0 pypandoc==1.15 pytest-sphinx==0.6.3 -pyvista==0.44.2 -sphinx==8.1.3 -numpydoc==1.8.0 +pyvista==0.45.2 +sphinx==8.2.3 sphinx-autodoc-typehints==3.0.1 sphinx-copybutton==0.5.0 sphinx-gallery==0.19.0 @@ -13,4 +13,4 @@ sphinx-notfound-page==1.1.0 sphinx-design===0.6.1 sphinxcontrib-napoleon==0.7 sphinxcontrib-websupport==2.0.0 -vtk==9.3.1 +vtk==9.4.2