doc: improve static search speed and fix missing module icons (#1971)

ansys · Dec 18, 2024 · c133af5 · c133af5
1 parent 4fcf544
commit c133af5
Show file tree

Hide file tree

Showing 787 changed files with 788 additions and 787 deletions.
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -231,7 +231,8 @@ def reset_servers(gallery_conf, fname, when):
     },
     "static_search": {
         "threshold": 0.5,
-        "min_chars_for_search": 2,
+        "limit": 10,
+        "minMatchCharLength": 2,
         "ignoreLocation": True,
     },
     "ansys_sphinx_theme_autoapi": {

diff --git a/src/ansys/dpf/core/animator.py b/src/ansys/dpf/core/animator.py
@@ -22,7 +22,7 @@
 
 """
 Animator
-========
+
 This module contains the DPF animator class.
 
 Contains classes used to animate results based on workflows using PyVista.

diff --git a/src/ansys/dpf/core/any.py b/src/ansys/dpf/core/any.py
@@ -24,7 +24,7 @@
 .. _ref_any:
 
 Any
-====================
+
 """
 
 import traceback

diff --git a/src/ansys/dpf/core/available_result.py b/src/ansys/dpf/core/available_result.py
@@ -22,7 +22,7 @@
 
 """
 AvailableResult
-===============
+
 """
 
 from typing import List

diff --git a/src/ansys/dpf/core/collection.py b/src/ansys/dpf/core/collection.py
@@ -23,7 +23,7 @@
 # -*- coding: utf-8 -*-
 """
 Collection
-===============
+
 """
 
 from __future__ import annotations

diff --git a/src/ansys/dpf/core/collection_base.py b/src/ansys/dpf/core/collection_base.py
@@ -22,7 +22,7 @@
 
 """
 CollectionBase
-==============
+
 Contains classes associated with the DPF collection.
 
 """

diff --git a/src/ansys/dpf/core/common.py b/src/ansys/dpf/core/common.py
@@ -22,7 +22,7 @@
 
 """
 Common
-======
+
 
 .. autoclass:: locations
    :members:

diff --git a/src/ansys/dpf/core/config.py b/src/ansys/dpf/core/config.py
@@ -22,7 +22,7 @@
 
 """
 Operator Configuration
-======================
+
 """
 
 import functools

diff --git a/src/ansys/dpf/core/core.py b/src/ansys/dpf/core/core.py
@@ -22,7 +22,7 @@
 
 """
 Core
-====
+
 """
 
 import os

diff --git a/src/ansys/dpf/core/custom_container_base.py b/src/ansys/dpf/core/custom_container_base.py
@@ -22,7 +22,7 @@
 
 """
 CustomContainerBase
-===================
+
 This module contains the `CustomContainerBase` class, which serves as a base
 for creating wrappers around `GenericDataContainer` objects.
 

diff --git a/src/ansys/dpf/core/custom_fields_container.py b/src/ansys/dpf/core/custom_fields_container.py
@@ -22,7 +22,7 @@
 
 """
 Custom Fields Containers
-========================
+
 Contains the inherited classes from the
 :class:`FieldsContainer <ansys.dpf.core.fields_container.FieldsContainer>` class.
 These new classes offer helpers to access data for specific usage, such as

diff --git a/src/ansys/dpf/core/custom_operator.py b/src/ansys/dpf/core/custom_operator.py
@@ -24,7 +24,7 @@
 .. _ref_custom_operator:
 
 Custom Operator Base
-====================
+
 Contains utilities allowing you to implement and record custom Python operators.
 """
 

diff --git a/src/ansys/dpf/core/custom_type_field.py b/src/ansys/dpf/core/custom_type_field.py
@@ -24,7 +24,7 @@
 .. _ref_custom_type_field:
 
 CustomTypeField
-===============
+
 """
 
 import warnings

diff --git a/src/ansys/dpf/core/cyclic_support.py b/src/ansys/dpf/core/cyclic_support.py
@@ -22,7 +22,7 @@
 
 """
 Cyclic Support
-==============
+
 """
 
 import traceback

diff --git a/src/ansys/dpf/core/data_sources.py b/src/ansys/dpf/core/data_sources.py
@@ -24,7 +24,7 @@
 .. _ref_data_sources:
 
 Data Sources
-============
+
 """
 
 import os

diff --git a/src/ansys/dpf/core/data_tree.py b/src/ansys/dpf/core/data_tree.py
@@ -24,7 +24,7 @@
 .. _ref_data_tree:
 
 DataTree
-========
+
 """
 
 import enum

diff --git a/src/ansys/dpf/core/dimensionality.py b/src/ansys/dpf/core/dimensionality.py
@@ -22,7 +22,7 @@
 
 """
 Dimensionality
-==============
+
 """
 
 from ansys.dpf.core.common import natures

diff --git a/src/ansys/dpf/core/dpf_array.py b/src/ansys/dpf/core/dpf_array.py
@@ -23,7 +23,7 @@
 """
 
 DPFArray
-========
+
 
 .. autoclass:: DPFArray
    :members:

diff --git a/src/ansys/dpf/core/dpf_operator.py b/src/ansys/dpf/core/dpf_operator.py
@@ -24,7 +24,7 @@
 .. _ref_operator:
 
 Operator
-========
+
 """
 
 import logging

diff --git a/src/ansys/dpf/core/element_descriptor.py b/src/ansys/dpf/core/element_descriptor.py
@@ -22,7 +22,7 @@
 
 """
 Element Descriptor
-==================
+
 """
 
 

diff --git a/src/ansys/dpf/core/elements.py b/src/ansys/dpf/core/elements.py
@@ -24,7 +24,7 @@
 .. _ref_elements_apis:
 
 Elements
-========
+
 """
 
 from __future__ import annotations

diff --git a/src/ansys/dpf/core/errors.py b/src/ansys/dpf/core/errors.py
@@ -24,7 +24,7 @@
 .. _ref_errors:
 
 Errors
-======
+
 
 .. autoexception:: DpfVersionNotSupported
    :members:

diff --git a/src/ansys/dpf/core/examples/downloads.py b/src/ansys/dpf/core/examples/downloads.py
@@ -22,7 +22,7 @@
 
 """
 Downloads
-=========
+
 Download example datasets from https://github.com/ansys/example-data"""
 
 import os

diff --git a/src/ansys/dpf/core/faces.py b/src/ansys/dpf/core/faces.py
@@ -24,7 +24,7 @@
 .. _ref_faces_apis:
 
 Faces
-=====
+
 """
 
 import numpy as np

diff --git a/src/ansys/dpf/core/field.py b/src/ansys/dpf/core/field.py
@@ -24,7 +24,7 @@
 .. _ref_field:
 
 Field
-=====
+
 """
 
 import numpy as np

diff --git a/src/ansys/dpf/core/field_definition.py b/src/ansys/dpf/core/field_definition.py
@@ -22,7 +22,7 @@
 
 """
 FieldDefinition
-================
+
 """
 
 import traceback

diff --git a/src/ansys/dpf/core/fields_container.py b/src/ansys/dpf/core/fields_container.py
@@ -24,7 +24,7 @@
 .. _ref_fields_container:
 
 FieldsContainer
-===============
+
 Contains classes associated with the DPF FieldsContainer.
 """
 

diff --git a/src/ansys/dpf/core/fields_container_factory.py b/src/ansys/dpf/core/fields_container_factory.py
@@ -22,7 +22,7 @@
 
 """
 fields_container_factory
-========================
+
 
 Contains functions to simplify creating a fields container.
 """

diff --git a/src/ansys/dpf/core/fields_factory.py b/src/ansys/dpf/core/fields_factory.py
@@ -22,7 +22,7 @@
 
 """
 fields_factory
-==============
+
 
 Contains functions to simplify creating fields.
 """

diff --git a/src/ansys/dpf/core/generic_data_container.py b/src/ansys/dpf/core/generic_data_container.py
@@ -24,7 +24,7 @@
 .. _ref_generic_data_container:
 
 GenericDataContainer
-====================
+
 """
 
 from __future__ import annotations

diff --git a/src/ansys/dpf/core/generic_support.py b/src/ansys/dpf/core/generic_support.py
@@ -24,7 +24,7 @@
 .. _ref_genericsupport:
 
 GenericSupport
-==============
+
 """
 
 from ansys.dpf.gate import generic_support_capi, generic_support_grpcapi

diff --git a/src/ansys/dpf/core/geometry.py b/src/ansys/dpf/core/geometry.py
@@ -24,7 +24,7 @@
 .. _ref_geometry:
 
 Geometry
-========
+
 Module containing the different geometry objects.
 
 """

diff --git a/src/ansys/dpf/core/geometry_factory.py b/src/ansys/dpf/core/geometry_factory.py
@@ -24,7 +24,7 @@
 .. _ref_geometry_factory:
 
 Geometry Factory
-================
+
 Geometry factory module containing functions to create the different geometries.
 
 """

diff --git a/src/ansys/dpf/core/incremental.py b/src/ansys/dpf/core/incremental.py
@@ -24,7 +24,7 @@
 .. _ref_incremental:
 
 Incremental
-===========
+
 """
 
 from ansys.dpf import core

diff --git a/src/ansys/dpf/core/inputs.py b/src/ansys/dpf/core/inputs.py
@@ -24,7 +24,7 @@
 .. _ref_inputs:
 
 Inputs
-======
+
 """
 
 import weakref

diff --git a/src/ansys/dpf/core/mesh_info.py b/src/ansys/dpf/core/mesh_info.py
@@ -22,7 +22,7 @@
 
 """
 MeshInfo
-==========
+
 """
 
 from ansys.dpf.core import server as server_module

diff --git a/src/ansys/dpf/core/mesh_scoping_factory.py b/src/ansys/dpf/core/mesh_scoping_factory.py
@@ -22,7 +22,7 @@
 
 """
 mesh_scoping_factory
-====================
+
 
 Contains functions to simplify creating mesh scopings.
 """

diff --git a/src/ansys/dpf/core/meshed_region.py b/src/ansys/dpf/core/meshed_region.py
@@ -22,7 +22,7 @@
 
 """
 MeshedRegion
-============
+
 """
 
 import traceback

diff --git a/src/ansys/dpf/core/meshes_container.py b/src/ansys/dpf/core/meshes_container.py
@@ -23,7 +23,7 @@
 # -*- coding: utf-8 -*-
 """
 MeshesContainer
-===============
+
 Contains classes associated with the DPF MeshesContainer.
 """
 

diff --git a/src/ansys/dpf/core/model.py b/src/ansys/dpf/core/model.py
@@ -24,7 +24,7 @@
 .. _ref_model:
 
 Model
-=====
+
 Module contains the Model class to manage file result models.
 
 

diff --git a/src/ansys/dpf/core/nodes.py b/src/ansys/dpf/core/nodes.py
@@ -24,7 +24,7 @@
 .. _ref_nodes_apis:
 
 Nodes
-=====
+
 """
 
 import numpy as np

diff --git a/src/ansys/dpf/core/operator_specification.py b/src/ansys/dpf/core/operator_specification.py
@@ -24,7 +24,7 @@
 .. _ref_operator_specification:
 
 Operator Specification
-======================
+
 The OperatorSpecification Provides a documentation for each Operator
 """
 

diff --git a/src/ansys/dpf/core/operators/averaging/elemental_difference.py b/src/ansys/dpf/core/operators/averaging/elemental_difference.py
@@ -1,6 +1,6 @@
 """
 elemental_difference
-====================
+
 Autogenerated DPF operator classes.
 """
 

diff --git a/src/ansys/dpf/core/operators/averaging/elemental_difference_fc.py b/src/ansys/dpf/core/operators/averaging/elemental_difference_fc.py
@@ -1,6 +1,6 @@
 """
 elemental_difference_fc
-=======================
+
 Autogenerated DPF operator classes.
 """
-Original file line number
+Diff line change
@@ Expand Up / @@ -24,7 +24,7 @@ @@
     .. _ref_any:
     Any
-    ====================
     """
     import traceback
@@ Expand Down @@