updates the examples package references

ansys · Nov 22, 2024 · cf3f844 · cf3f844
1 parent 706b595
commit cf3f844
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 7 deletions.
diff --git a/doc/source/user_guide/tutorials/plot/plotting_a_graph.rst b/doc/source/user_guide/tutorials/plot/plotting_a_graph.rst
@@ -9,6 +9,7 @@ Plotting data on a graph
 .. |MeshedRegion| replace:: :class:`MeshedRegion <ansys.dpf.core.meshed_region.MeshedRegion>`
 .. |Model| replace:: :class:`Model <ansys.dpf.core.model.Model>`
 .. |mapping| replace:: :class:`mapping <ansys.dpf.core.operators.mapping.on_coordinates.on_coordinates>`
+.. |Examples| replace:: :mod:`Examples<ansys.dpf.core.examples>`
 
 This part shows how to get a result plotted on a graph.
 
@@ -29,7 +30,7 @@ be defined check the :ref:`ref_plotting_data_on_specific_placements` tutorial.
 Define the data
 ^^^^^^^^^^^^^^^
 
-We will download a simple simulation result file available in our `Examples` package:
+We will download a simple simulation result file available in our |Examples| package:
 
 .. jupyter-execute::
 

diff --git a/doc/source/user_guide/tutorials/plot/plotting_data_on_deformed_mesh.rst b/doc/source/user_guide/tutorials/plot/plotting_data_on_deformed_mesh.rst
@@ -8,7 +8,8 @@ Plotting data on deformed mesh
 .. |MeshedRegion| replace:: :class:`MeshedRegion <ansys.dpf.core.meshed_region.MeshedRegion>`
 .. |Field| replace:: :class:`Field<ansys.dpf.core.field.Field>`
 .. |FieldsContainer| replace:: :class:`FieldsContainer<ansys.dpf.core.fields_container.FieldsContainer>`
-.. |MeshesContainer| replace:: :class:`MeshesContainer <ansys.dpf.core.meshes_container.MeshesContainer>`,
+.. |MeshesContainer| replace:: :class:`MeshesContainer <ansys.dpf.core.meshes_container.MeshesContainer>`
+.. |Examples| replace:: :mod:`Examples<ansys.dpf.core.examples>`
 
 This tutorial shows how to plot data on the deformed mesh. For more detailed information  on plotting data
 check the :ref:`ref_plotting_data_on_the_mesh` tutorial.
@@ -17,7 +18,7 @@ Define the data
 ---------------
 
 In this tutorial we will download a simulation result file available
-in our ``Examples`` package:
+in our |Examples| package:
 
 .. jupyter-execute::
 

diff --git a/doc/source/user_guide/tutorials/plot/plotting_data_on_geometry_elements.rst b/doc/source/user_guide/tutorials/plot/plotting_data_on_geometry_elements.rst
@@ -14,6 +14,7 @@ Plot data on geometry elements
 .. |Points| replace:: :class:`Points <ansys.dpf.core.geometry.Points>`
 .. |Plane| replace:: :class:`Plane <ansys.dpf.core.geometry.Plane>`
 .. |mapping| replace:: :class:`mapping <ansys.dpf.core.operators.mapping.on_coordinates.on_coordinates>`
+.. |Examples| replace:: :mod:`Examples<ansys.dpf.core.examples>`
 
 This tutorials shows how to get a result mapped over different geometric objects:
 
@@ -24,7 +25,7 @@ This tutorials shows how to get a result mapped over different geometric objects
 Define the data
 ---------------
 
-We will download a simple simulation result file available in our `Examples` package:
+We will download a simple simulation result file available in our |Examples| package:
 
 .. jupyter-execute::
 

diff --git a/doc/source/user_guide/tutorials/plot/plotting_data_on_specific_path.rst b/doc/source/user_guide/tutorials/plot/plotting_data_on_specific_path.rst
@@ -14,13 +14,14 @@ Plotting data on a specific path
 .. |Points| replace:: :class:`Points <ansys.dpf.core.geometry.Points>`
 .. |Plane| replace:: :class:`Plane <ansys.dpf.core.geometry.Plane>`
 .. |mapping| replace:: :class:`mapping <ansys.dpf.core.operators.mapping.on_coordinates.on_coordinates>`
+.. |Examples| replace:: :mod:`Examples<ansys.dpf.core.examples>`
 
 This tutorial shows how to get a result mapped over a specific path and how to plot it.
 
 Define the data
 ---------------
 
-We will download a simple simulation result file available in our `Examples` package:
+We will download a simple simulation result file available in our |Examples| package:
 
 .. jupyter-execute::
 

diff --git a/doc/source/user_guide/tutorials/plot/plotting_data_on_the_mesh.rst b/doc/source/user_guide/tutorials/plot/plotting_data_on_the_mesh.rst
@@ -15,14 +15,15 @@ Plotting data on the mesh
 .. |show_figure| replace:: :func:`show_figure()<ansys.dpf.core.plotter.DpfPlotter.show_figure>`
 .. |Field| replace:: :class:`Field<ansys.dpf.core.field.Field>`
 .. |FieldsContainer| replace:: :class:`FieldsContainer<ansys.dpf.core.fields_container.FieldsContainer>`
+.. |Examples| replace:: :mod:`Examples<ansys.dpf.core.examples>`
 
 This tutorial shows how to plot data on its supporting mesh by different approaches.
 
 Define the data
 ---------------
 
 In this tutorial we will download a simulation result file available
-in our ``Examples`` package:
+in our |Examples| package:
 
 .. jupyter-execute::
 

diff --git a/doc/source/user_guide/tutorials/plot/plotting_meshes.rst b/doc/source/user_guide/tutorials/plot/plotting_meshes.rst
@@ -13,6 +13,7 @@ Plotting meshes
 .. |DpfPlotter| replace:: :class:`DpfPlotter<ansys.dpf.core.plotter.DpfPlotter>`
 .. |add_mesh| replace:: :func:`add_mesh()<ansys.dpf.core.plotter.DpfPlotter.add_mesh>`
 .. |show_figure| replace:: :func:`show_figure()<ansys.dpf.core.plotter.DpfPlotter.show_figure>`
+.. |Examples| replace:: :mod:`Examples<ansys.dpf.core.examples>`
 
 DPF-Core has a variety of plotting methods for generating 3D plots of
 Ansys models directly from Python. These methods use VTK and leverage
@@ -29,7 +30,7 @@ The mesh object in DPF is a |MeshedRegion|. You can plot a |MeshedRegion| or a
 |MeshesContainer|, that is a collection of |MeshedRegion|.
 
 In this tutorial we will download a pontoon simulation result file available in
-our `Examples` package:
+our |Examples| package:
 
 .. jupyter-execute::