Skip to content

Commit

Permalink
fix: broken references corrected
Browse files Browse the repository at this point in the history
  • Loading branch information
moe-ad committed Jan 10, 2025
1 parent ac9d63f commit 31249e1
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 15 deletions.
2 changes: 1 addition & 1 deletion doc/source/user_guide/custom_operators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -249,5 +249,5 @@ Once the plugin is loaded, you can instantiate the custom operator:
References
----------
For more information, see :ref:`ref_custom_operator` in the **API reference**
For more information, see :py:mod:`Custom Operator Base <ansys.dpf.core.custom_operator>` in the **API reference**
and :ref:`python_operators` in **Examples**.
4 changes: 2 additions & 2 deletions doc/source/user_guide/fields_container.rst
Original file line number Diff line number Diff line change
Expand Up @@ -574,5 +574,5 @@ For comprehensive information on chaining operators, see :ref:`ref_user_guide_op

API reference
-------------
For more information, see :ref:`ref_fields_container` and
:ref:`ref_field` in the **API reference**.
For more information, see :py:mod:`FieldsContainer <ansys.dpf.core.fields_container>` and
:py:mod:`Field <ansys.dpf.core.field>` in the **API reference**.
8 changes: 4 additions & 4 deletions doc/source/user_guide/model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ To understand what is available in the result file, you can print the model
For a comprehensive model example, see :ref:`ref_basic_example`.

For a description of the ``Model`` object, see :ref:`ref_model`.
For a description of the ``Model`` object, see :py:mod:`Model <ansys.dpf.core.model>`.


Model metadata
Expand Down Expand Up @@ -125,7 +125,7 @@ This example shows how you get time sets:
[1.]
For a description of the ``Metadata`` object, see :ref:`ref_model`.
For a description of the ``Metadata`` object, see :py:mod:`Model <ansys.dpf.core.model>`.

Model results
-------------
Expand Down Expand Up @@ -176,11 +176,11 @@ the mesh scoping:
For an example using the ``Result`` object, see :ref:`ref_transient_easy_time_scoping`.

For a description of the ``Model`` object, see :ref:`ref_results`.
For a description of the ``Model`` object, see :py:mod:`Model <ansys.dpf.core.model>`.



API reference
~~~~~~~~~~~~~

For more information, see :ref:`ref_model` or :ref:`ref_results`.
For more information, see :py:mod:`Model <ansys.dpf.core.model>` or :py:mod:`Results <ansys.dpf.core.results>`.
14 changes: 7 additions & 7 deletions doc/source/user_guide/operators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,9 @@ which is progressively enhanced, see :ref:`ref_dpf_operators_reference`.

Create operators
~~~~~~~~~~~~~~~~
Each operator is of type :ref:`ref_operator`. You can create an instance
Each operator is of type :py:mod:`Operator <ansys.dpf.core.dpf_operator>`. You can create an instance
in Python with any of the derived classes available in the
:ref:`ansys.dpf.core.operators package` or directly with the :ref:`ref_operator`
:py:mod:`ansys.dpf.core.operators` package or directly with the :py:mod:`Operator <ansys.dpf.core.dpf_operator>`
class using the internal name string that indicates the operator type.
For more information, see :ref:`ref_dpf_operators_reference`.

Expand Down Expand Up @@ -123,8 +123,8 @@ results, you must provide paths for the result files.

You can create data sources in two ways:

- Use the :ref:`ref_model` class.
- Use the :ref:`ref_data_sources` class.
- Use the :py:mod:`Model <ansys.dpf.core.model>` class.
- Use the :py:mod:`Data Sources <ansys.dpf.core.data_sources>` class.


Because several other examples use the ``Model`` class, this example uses the
Expand Down Expand Up @@ -154,7 +154,7 @@ This code demonstrates how to connect the data source to the displacement operat
op.inputs.data_sources(data_src)
You can connect other optional inputs to the displacement operator.
The output from printing the operator shows that a ``mesh_scoping`` of type :ref:`ref_scoping`
The output from printing the operator shows that a ``mesh_scoping`` of type :py:mod:`Scoping <ansys.dpf.core.scoping>`
can be connected to work on a spatial subset. A ``time_scoping`` of a list of integers
can also be connected to work on a temporal subset:

Expand Down Expand Up @@ -441,5 +441,5 @@ Python client is not on the same machine as the server:
API reference
~~~~~~~~~~~~~
For a list of all operators in DPF, see :ref:`ref_dpf_operators_reference`
or the package :ref:`ansys.dpf.core.operators package`. For more information about the
class itself, see :ref:`ref_operator`.
or the package :py:mod:`ansys.dpf.core.operators`. For more information about the
class itself, see :py:mod:`Operator <ansys.dpf.core.dpf_operator>`.
1 change: 0 additions & 1 deletion src/ansys/dpf/core/model.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@
Model.
Module contains the Model class to manage file result models.
"""

from ansys import dpf
Expand Down

0 comments on commit 31249e1

Please sign in to comment.