Reorganize Python API docs: grouped class index and enum reference

docs/source/EnumClasses.rst

@@ -0,0 +1,246 @@
+.. This file is auto-generated by generate_class_index.py - do not edit manually.
+
+.. _EnumClasses:
+
+Enum Classes
+============
+A number of API fields and command parameters accept one of a fixed set
+of values. Those value sets are defined by the enum classes listed
+below. Each class is a :class:`~enum.StrEnum`, so a member can be passed
+either directly (``rips.BetaFactorType.FractureBetaFactor``) or as its
+plain string value (``"FractureBetaFactor"``).
+
+.. autoclass:: rips.AutoWellShutIn
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.BetaFactorType
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.CombineMode
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.CompletionType
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.ConductivityType
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.ControlMode
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.DepthType
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.DepthUnit
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.DiameterRoughnessMode
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.DrillingType
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.ExtractionType
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.FilterCakePressureDrop
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.FlowTracerSelectionMode
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.FractureOrientation
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.FractureWidthType
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.GasInflowEq
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.GeometryType
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.HydrostaticDensity
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.LengthAndDepth
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.NNCPropertyType
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.NameSetting
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.NonDarcyFlowType
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.NonDarcyFlowType2
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.Orientation
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.PercentileCalculationType
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.PermeabilityType
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.PhaseSelection
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.PorePressureReservoirSource
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.PorosityModelType
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.PressureDrop
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.Property
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.PropertyDataType
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.PropertyType
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.ReferenceMdType
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.ResultType
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.ShowDepthGridLines
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.State
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.State2
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.SubTitleFontSize
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.SubsOrientationMode
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.Type2
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.ValveType
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.ValveUnits
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.WellState
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.WellStatus
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.WellType
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: rips.WellTypeForExport
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/GeneratedClasses.rst

@@ -1,3 +1,5 @@
+.. This file is auto-generated by generate_class_index.py - do not edit manually.
+
 .. _AllClasses:
 
 Project Tree Classes
@@ -12,9 +14,34 @@ You can look for objects of a specific type by using the **descendants** method
    resinsight = rips.Instance.find()
    # Example code
    print("ResInsight version: " + resinsight.version_string())
-   # Get a list of all Eclipsev view in the project
+   # Get a list of all Eclipse views in the project
    views = resinsight.project.descendants(rips.EclipseView)
 
-.. automodapi:: rips
+The classes are grouped by topic. Select a topic below to see its
+classes; each class links to its full API reference. Members shared by
+every class are documented once on :ref:`PdmObjectBaseLabel`.
+
 
+.. toctree::
+   :maxdepth: 1
 
+   api_categories/application_and_project
+   api_categories/cases_and_case_collections
+   api_categories/grids
+   api_categories/summary_data
+   api_categories/views_and_contour_maps
+   api_categories/cell_results_and_color_legends
+   api_categories/cell_filters_and_intersections
+   api_categories/annotations_and_polygons
+   api_categories/wells_and_well_paths
+   api_categories/well_events
+   api_categories/well_logs
+   api_categories/well_log_plots
+   api_categories/perforations_and_fishbones
+   api_categories/valves
+   api_categories/fractures
+   api_categories/well_bore_stability
+   api_categories/surfaces
+   api_categories/plots_and_curves
+   api_categories/data_containers_and_statistics
+   api_categories/base_classes