Fix(doc): Fix DPF operator doc update of the toc.yml

[PProfizi]

No description provided.

[github-actions]

Some tests with 'continue-on-error: true' have failed:

• PyDPF-Post API tests on ubuntu-latest

Created by continue-on-error-comment

[codecov]

❌ 2 Tests Failed:

Tests completed	Failed	Passed	Skipped
1969	2	1967	112

View the top 3 failed test(s) by shortest run time

tests\test_scopingscontainer.py::test_scopingscontainer::test_set_get_scoping_scopings_container_new_label[gRPC CLayer]

Stack Traces | 1.34s run time

elshape_body_sc = <ansys.dpf.core.scopings_container.ScopingsContainer object at 0x000001FD34D9E0B0>

    def test_set_get_scoping_scopings_container_new_label(elshape_body_sc):
        sc = elshape_body_sc
        assert sc.get_available_ids_for_label("elshape") == list(range(1, 21))
        for i in range(0, 20):
            scopingid = sc.get_scoping({"elshape": i + 1, "body": 0})._internal_obj
            assert scopingid is not None
            assert sc.get_scoping(i)._internal_obj is not None
            assert sc.get_scoping({"elshape": i + 1, "body": 0})._internal_obj is not None
            assert sc[i]._internal_obj is not None
            assert sc.get_label_space(i) == {"elshape": i + 1, "body": 0}
>           assert np.allclose(sc.get_scoping({"elshape": i + 1, "body": 0}).ids, list(range(0, i + 1)))

tests\test_scopingscontainer.py:97: 
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
.tox\test-api\lib\site-packages\numpy\_core\numeric.py:2329: in allclose
    res = all(isclose(a, b, rtol=rtol, atol=atol, equal_nan=equal_nan))
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

a = DPFArray([0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
          0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,...0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
          0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], dtype=int32)
b = [0, 1, 2, 3, 4, 5, ...], rtol = 1e-05, atol = 1e-08, equal_nan = False

    @array_function_dispatch(_isclose_dispatcher)
    def isclose(a, b, rtol=1.e-5, atol=1.e-8, equal_nan=False):
        """
        Returns a boolean array where two arrays are element-wise equal within a
        tolerance.
    
        The tolerance values are positive, typically very small numbers.  The
        relative difference (`rtol` * abs(`b`)) and the absolute difference
        `atol` are added together to compare against the absolute difference
        between `a` and `b`.
    
        .. warning:: The default `atol` is not appropriate for comparing numbers
                     with magnitudes much smaller than one (see Notes).
    
        Parameters
        ----------
        a, b : array_like
            Input arrays to compare.
        rtol : array_like
            The relative tolerance parameter (see Notes).
        atol : array_like
            The absolute tolerance parameter (see Notes).
        equal_nan : bool
            Whether to compare NaN's as equal.  If True, NaN's in `a` will be
            considered equal to NaN's in `b` in the output array.
    
        Returns
        -------
        y : array_like
            Returns a boolean array of where `a` and `b` are equal within the
            given tolerance. If both `a` and `b` are scalars, returns a single
            boolean value.
    
        See Also
        --------
        allclose
        math.isclose
    
        Notes
        -----
        For finite values, isclose uses the following equation to test whether
        two floating point values are equivalent.::
    
         absolute(a - b) <= (atol + rtol * absolute(b))
    
        Unlike the built-in `math.isclose`, the above equation is not symmetric
        in `a` and `b` -- it assumes `b` is the reference value -- so that
        `isclose(a, b)` might be different from `isclose(b, a)`.
    
        The default value of `atol` is not appropriate when the reference value
        `b` has magnitude smaller than one. For example, it is unlikely that
        ``a = 1e-9`` and ``b = 2e-9`` should be considered "close", yet
        ``isclose(1e-9, 2e-9)`` is ``True`` with default settings. Be sure
        to select `atol` for the use case at hand, especially for defining the
        threshold below which a non-zero value in `a` will be considered "close"
        to a very small or zero value in `b`.
    
        `isclose` is not defined for non-numeric data types.
        :class:`bool` is considered a numeric data-type for this purpose.
    
        Examples
        --------
        >>> import numpy as np
        >>> np.isclose([1e10,1e-7], [1.00001e10,1e-8])
        array([ True, False])
    
        >>> np.isclose([1e10,1e-8], [1.00001e10,1e-9])
        array([ True, True])
    
        >>> np.isclose([1e10,1e-8], [1.0001e10,1e-9])
        array([False,  True])
    
        >>> np.isclose([1.0, np.nan], [1.0, np.nan])
        array([ True, False])
    
        >>> np.isclose([1.0, np.nan], [1.0, np.nan], equal_nan=True)
        array([ True, True])
    
        >>> np.isclose([1e-8, 1e-7], [0.0, 0.0])
        array([ True, False])
    
        >>> np.isclose([1e-100, 1e-7], [0.0, 0.0], atol=0.0)
        array([False, False])
    
        >>> np.isclose([1e-10, 1e-10], [1e-20, 0.0])
        array([ True,  True])
    
        >>> np.isclose([1e-10, 1e-10], [1e-20, 0.999999e-10], atol=0.0)
        array([False,  True])
    
        """
        # Turn all but python scalars into arrays.
        x, y, atol, rtol = (
            a if isinstance(a, (int, float, complex)) else asanyarray(a)
            for a in (a, b, atol, rtol))
    
        # Make sure y is an inexact type to avoid bad behavior on abs(MIN_INT).
        # This will cause casting of x later. Also, make sure to allow subclasses
        # (e.g., for numpy.ma).
        # NOTE: We explicitly allow timedelta, which used to work. This could
        #       possibly be deprecated. See also gh-18286.
        #       timedelta works if `atol` is an integer or also a timedelta.
        #       Although, the default tolerances are unlikely to be useful
        if (dtype := getattr(y, "dtype", None)) is not None and dtype.kind != "m":
            dt = multiarray.result_type(y, 1.)
            y = asanyarray(y, dtype=dt)
        elif isinstance(y, int):
            y = float(y)
    
        with errstate(invalid='ignore'):
>           result = (less_equal(abs(x-y), atol + rtol * abs(y))
                      & isfinite(y)
                      | (x == y))
E           ValueError: operands could not be broadcast together with shapes (100,) (10,)

.tox\test-api\lib\site-packages\numpy\_core\numeric.py:2447: ValueError

test_documentation\test_documentation.py::test_documentation::test_generate_operators_doc_plugin_and_update

Stack Traces | 288s run time

tmp_path = WindowsPath('D:.../pydpf-core/pydpf-core/.tox.../pytest-of-unknown/pytest-0/test_generate_operators_doc_pl2')

    def test_generate_operators_doc_plugin_and_update(tmp_path: Path):
        specs_path = tmp_path / "operator-specifications"
        specs_path.mkdir()
        utility_path = specs_path / "utility"
        utility_path.mkdir()
        forward_update_path = utility_path / "forward_upd.md"
        test_string = r"""## Description
    
    Test update"""
        with forward_update_path.open(mode="w", encoding="utf-8") as ff:
            ff.write(test_string)
>       generate_operators_doc(
            ansys_path=dpf.SERVER.ansys_path,
            output_path=tmp_path,
            verbose=False,
            desired_plugin="core",
        )

test_documentation\test_documentation.py:48: 
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
.tox\test-documentation\lib\site-packages\ansys\dpf\core\documentation\generate_operators_doc.py:463: in generate_operators_doc
    update_toc_tree(output_path)
.tox\test-documentation\lib\site-packages\ansys\dpf\core\documentation\generate_operators_doc.py:410: in update_toc_tree
    with toc_path.open(mode="r") as file:
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

self = WindowsPath('D:.../pydpf-core/pydpf-core/.tox.../pytest-of-unknown/pytest-0/test_generate_operators_doc_pl2/toc.yml')
mode = 'r', buffering = -1, encoding = 'locale', errors = None, newline = None

    def open(self, mode='r', buffering=-1, encoding=None,
             errors=None, newline=None):
        """
        Open the file pointed by this path and return a file object, as
        the built-in open() function does.
        """
        if "b" not in mode:
            encoding = io.text_encoding(encoding)
>       return self._accessor.open(self, mode, buffering, encoding, errors,
                                   newline)
E       FileNotFoundError: [Errno 2] No such file or directory: 'D:\\a\\pydpf-core\\pydpf-core\\.tox\\test-documentation\\tmp\\pytest-of-unknown\\pytest-0\\test_generate_operators_doc_pl2\\toc.yml'

C:\hostedtoolcache\windows\Python\3.10.11\x64\lib\pathlib.py:1119: FileNotFoundError

test_documentation\test_documentation.py::test_documentation::test_generate_operators_doc

Stack Traces | 353s run time

tmp_path = WindowsPath('D:.../pydpf-core/pydpf-core/.tox.../pytest-of-unknown/pytest-0/test_generate_operators_doc2')

    def test_generate_operators_doc(tmp_path: Path):
>       generate_operators_doc(ansys_path=dpf.SERVER.ansys_path, output_path=tmp_path, verbose=False)

test_documentation\test_documentation.py:30: 
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
.tox\test-documentation\lib\site-packages\ansys\dpf\core\documentation\generate_operators_doc.py:463: in generate_operators_doc
    update_toc_tree(output_path)
.tox\test-documentation\lib\site-packages\ansys\dpf\core\documentation\generate_operators_doc.py:410: in update_toc_tree
    with toc_path.open(mode="r") as file:
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

self = WindowsPath('D:.../pydpf-core/pydpf-core/.tox.../pytest-of-unknown/pytest-0/test_generate_operators_doc2/toc.yml')
mode = 'r', buffering = -1, encoding = 'locale', errors = None, newline = None

    def open(self, mode='r', buffering=-1, encoding=None,
             errors=None, newline=None):
        """
        Open the file pointed by this path and return a file object, as
        the built-in open() function does.
        """
        if "b" not in mode:
            encoding = io.text_encoding(encoding)
>       return self._accessor.open(self, mode, buffering, encoding, errors,
                                   newline)
E       FileNotFoundError: [Errno 2] No such file or directory: 'D:\\a\\pydpf-core\\pydpf-core\\.tox\\test-documentation\\tmp\\pytest-of-unknown\\pytest-0\\test_generate_operators_doc2\\toc.yml'

C:\hostedtoolcache\windows\Python\3.10.11\x64\lib\pathlib.py:1119: FileNotFoundError

To view more test analytics, go to the Test Analytics Dashboard
_{📋 Got 3 mins? Take this short survey to help us improve Test Analytics.}