Skip to content

Commit

Permalink
Avoid using class names as headings, causes duplicate references
Browse files Browse the repository at this point in the history
If a class name is used as a heading, this is used as a index, and causes duplicate definitions of the same name.
  • Loading branch information
magnesj committed Jan 30, 2021
1 parent b457e02 commit 77b40f7
Showing 1 changed file with 17 additions and 35 deletions.
52 changes: 17 additions & 35 deletions docs/source/rips.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Main Classes
============

Case
----
Case class
----------
Access to case information.
Inherits :ref:`PdmObjectBase<PdmObjectBaseLabel>` and all its members.

Expand Down Expand Up @@ -39,23 +39,17 @@ result
FLOW_DIAGNOSTICS | |
INJECTION_FLOODING | |

.. autoclass:: rips.Case
:members:
:undoc-members:
:show-inheritance:
Detailed documentation :class:`rips.Case`

Examples
^^^^^^^^
See :ref:`all_cases`, :ref:`load_case` and :ref:`selected_cases`.

Grid
----
Grid class
----------
Access to grid information

.. autoclass:: rips.Grid
:members:
:undoc-members:
:show-inheritance:
Detailed documentation :class:`rips.Grid`

Examples
^^^^^^^^
Expand All @@ -71,19 +65,16 @@ The basic access class to ResInsight. Use to find or launch a running instance o
# Get the ResInsight project
project = resinsight.project

.. autoclass:: rips.Instance
:members:
:undoc-members:
:show-inheritance:
Detailed documentation :class:`rips.Instance`

Examples
^^^^^^^^
See :ref:`instance_example` and :ref:`launch_with_commandline_options`.

.. _PdmObjectBaseLabel:

PdmObjectBase
-------------
PdmObjectBase class
-------------------
The base class of all data classes in ResInsight. Not used directly but all attributes
and methods are available in the other ResInsight data classes.

Expand All @@ -98,13 +89,10 @@ ancestors(), children() and descendants() using a class name as the argument ::

See :ref:`AllClasses` for all classes based on PdmObjectBase.

.. autoclass:: rips.PdmObjectBase
:members:
:undoc-members:
:show-inheritance:
Detailed documentation :class:`rips.PdmObjectBase`

Project
-------
Project class
-------------
The ResInsight project. Inherits :ref:`PdmObjectBase<PdmObjectBaseLabel>` and all its members.
Always available as an object member "project" on the rips.Instance ::

Expand All @@ -115,25 +103,19 @@ Always available as an object member "project" on the rips.Instance ::
# Get the project
project = resinsight.project

.. autoclass:: rips.Project
:members:
:undoc-members:
:show-inheritance:
Detailed documentation :class:`rips.Project`

Examples
^^^^^^^^
See :ref:`open_project`

View
----
View class
----------
The base class of all views in ResInsight.
Inherits :ref:`PdmObjectBase<PdmObjectBaseLabel>` and all its members

.. autoclass:: rips.View
:members:
:undoc-members:
:show-inheritance:
Detailed documentation :class:`rips.View`

Examples
^^^^^^^^
See :ref:`view_example` and :ref:`set_cell_result`.
See :ref:`view_example` and :ref:`set_cell_result`.

0 comments on commit 77b40f7

Please sign in to comment.