Add and document an [examples] extra requirement (#525)

Define the optional dependencies used in the examples, and document how to install them. Co-authored-by: Nellie Shum <[email protected]>
ansys · Sep 27, 2024 · d31da84 · d31da84
1 parent 9fbfe47
commit d31da84
Show file tree

Hide file tree

Showing 3 changed files with 1,588 additions and 1,388 deletions.
diff --git a/doc/source/intro.rst b/doc/source/intro.rst
@@ -13,7 +13,14 @@ Install the ``ansys-dpf-composites`` package with ``pip``:
 
     pip install ansys-dpf-composites
 
-Specific versions can be installed by specifying the version in the pip command. For example: Ansys 2023 R1 requires ansys-dpf-composites version 0.1.0:
+
+To install the optional dependencies used in the examples, add the ``[examples]`` suffix when installing the package:
+
+.. code::
+
+    pip install ansys-dpf-composites[examples]
+
+Specific versions can be installed by specifying the version in the pip command. For example, Ansys 2023 R1 requires ansys-dpf-composites version 0.1.0:
 
 .. code::