Documentation: Doc/several operators page (#646)

* Now two Operators pages are available. Still have to add the drop-down menu.

* Explain server contexts

* Script used to generate both entry and premium docs

* Link to newly generated dpf_entry.html and premium_entry.html in _static

* Fix flake8

* Add card for the operators

* Add correct path to images

* Apply suggestions from code review

Co-authored-by: Maxime Rey <[email protected]>

* Add back static html pages

* Rework Operators landing page.

* Update operator_reference.rst

* Update text

* Update entry and premium docs

* Some PR comments

* Last comments

* Apply suggestions from code review

Co-authored-by: Kathy Pippert <[email protected]>

* Apply suggestions from code review

Co-authored-by: Kathy Pippert <[email protected]>

* Remove images for operators

* update entry and premium docs

* Style check

Co-authored-by: paul.profizi <[email protected]>
Co-authored-by: Revathyvenugopal162 <[email protected]>
Co-authored-by: Revathy Venugopal <[email protected]>
Co-authored-by: Maxime Rey <[email protected]>
Co-authored-by: PProfizi <[email protected]>
Co-authored-by: Kathy Pippert <[email protected]>

Author: 5 people

.ci/operator_doc_per_context.py

@@ -0,0 +1,17 @@
+import ansys.dpf.core as dpf
+from ansys.dpf.core.server_context import \
+    apply_server_context, AvailableServerContexts, SERVER_CONTEXT
+
+print(f"Server version: {dpf.global_server().version}")
+# Generate entry documentation
+print("Generating entry operator documentation")
+print(f"Current context: {SERVER_CONTEXT}")
+dpf.operators.utility.html_doc(r"../docs/source/_static/dpf_entry.html").eval()
+print("Done.\n")
+
+# Generate premium documentation
+print("Generating premium operator documentation")
+apply_server_context(AvailableServerContexts.premium)
+print(f"Current context: {SERVER_CONTEXT}")
+dpf.operators.utility.html_doc(r"../docs/source/_static/dpf_premium.html").eval()
+print("Done.\n")

ansys/dpf/core/custom_type_field.py

@@ -38,9 +38,9 @@ def __missing__(self, key):
 
 class CustomTypeField(_FieldBase):
     """Represents a simulation data container with each unitary data being of a custom type.
-    When initiliazing the CustomTypeField, a unitary data type should be given.
-    The ``CustomTypeField`` gives the ability to choose the most optimized unitary data type
-    for a given usage, and hence, allows to optimize memory usage.
+    When initializing the ``CustomTypeField`` class, provide a unitary data type.
+    The ``CustomTypeField`` class gives you the ability to choose the most optimized unitary
+    data type for a given usage, and hence, allows you to optimize memory usage.
 
     This can be evaluated data from the :class:`Operator <ansys.dpf.core.Operator>` class
     or created directly by an instance of this class.

ansys/dpf/core/elements.py

@@ -615,7 +615,7 @@ def mapping_id_to_index(self) -> dict:
         """
         Mapping between the IDs and indices of the entity.
 
-        This proprty is useful for mapping scalar results from a field to the meshed region.
+        This property is useful for mapping scalar results from a field to the meshed region.
 
         Examples
         --------

ansys/dpf/core/server_factory.py

@@ -465,7 +465,7 @@ def replace_with_mounted_volumes(self, path: str) -> str:
         Parameters
         ----------
         path: str
-            Path to search for mounted volumes occurrences.
+            Path to search for occurrences of mounted volumes.
 
         Returns
         -------