Skip to content

Doc: improve static search speed and fix missing module icons #1971

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
3 changes: 2 additions & 1 deletion doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/animator.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

"""
Animator
========

This module contains the DPF animator class.

Contains classes used to animate results based on workflows using PyVista.
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/any.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
.. _ref_any:

Any
====================

"""

import traceback
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/available_result.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

"""
AvailableResult
===============

"""

from typing import List
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/collection.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
# -*- coding: utf-8 -*-
"""
Collection
===============

"""

from __future__ import annotations
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/collection_base.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

"""
CollectionBase
==============

Contains classes associated with the DPF collection.

"""
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/common.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

"""
Common
======


.. autoclass:: locations
:members:
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

"""
Operator Configuration
======================

"""

import functools
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

"""
Core
====

"""

import os
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/custom_container_base.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

"""
CustomContainerBase
===================

This module contains the `CustomContainerBase` class, which serves as a base
for creating wrappers around `GenericDataContainer` objects.

Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/custom_fields_container.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/custom_operator.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
.. _ref_custom_operator:

Custom Operator Base
====================

Contains utilities allowing you to implement and record custom Python operators.
"""

Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/custom_type_field.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
.. _ref_custom_type_field:

CustomTypeField
===============

"""

import warnings
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/cyclic_support.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

"""
Cyclic Support
==============

"""

import traceback
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/data_sources.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
.. _ref_data_sources:

Data Sources
============

"""

import os
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/data_tree.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
.. _ref_data_tree:

DataTree
========

"""

import enum
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/dimensionality.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

"""
Dimensionality
==============

"""

from ansys.dpf.core.common import natures
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/dpf_array.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"""

DPFArray
========


.. autoclass:: DPFArray
:members:
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/dpf_operator.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
.. _ref_operator:

Operator
========

"""

import logging
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/element_descriptor.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

"""
Element Descriptor
==================

"""


Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/elements.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
.. _ref_elements_apis:

Elements
========

"""

from __future__ import annotations
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/errors.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
.. _ref_errors:

Errors
======


.. autoexception:: DpfVersionNotSupported
:members:
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/examples/downloads.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

"""
Downloads
=========

Download example datasets from https://github.com/ansys/example-data"""

import os
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/faces.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
.. _ref_faces_apis:

Faces
=====

"""

import numpy as np
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/field.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
.. _ref_field:

Field
=====

"""

import numpy as np
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/field_definition.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

"""
FieldDefinition
================

"""

import traceback
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/fields_container.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
.. _ref_fields_container:

FieldsContainer
===============

Contains classes associated with the DPF FieldsContainer.
"""

Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/fields_container_factory.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

"""
fields_container_factory
========================


Contains functions to simplify creating a fields container.
"""
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/fields_factory.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

"""
fields_factory
==============


Contains functions to simplify creating fields.
"""
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/generic_data_container.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
.. _ref_generic_data_container:

GenericDataContainer
====================

"""

from __future__ import annotations
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/generic_support.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
.. _ref_genericsupport:

GenericSupport
==============

"""

from ansys.dpf.gate import generic_support_capi, generic_support_grpcapi
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/geometry.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
.. _ref_geometry:

Geometry
========

Module containing the different geometry objects.

"""
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/geometry_factory.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
.. _ref_geometry_factory:

Geometry Factory
================

Geometry factory module containing functions to create the different geometries.

"""
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/incremental.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
.. _ref_incremental:

Incremental
===========

"""

from ansys.dpf import core
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/inputs.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
.. _ref_inputs:

Inputs
======

"""

import weakref
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/mesh_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

"""
MeshInfo
==========

"""

from ansys.dpf.core import server as server_module
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/mesh_scoping_factory.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

"""
mesh_scoping_factory
====================


Contains functions to simplify creating mesh scopings.
"""
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/meshed_region.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

"""
MeshedRegion
============

"""

import traceback
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/meshes_container.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
# -*- coding: utf-8 -*-
"""
MeshesContainer
===============

Contains classes associated with the DPF MeshesContainer.
"""

Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/model.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
.. _ref_model:

Model
=====

Module contains the Model class to manage file result models.


Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/nodes.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
.. _ref_nodes_apis:

Nodes
=====

"""

import numpy as np
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/operator_specification.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
.. _ref_operator_specification:

Operator Specification
======================

The OperatorSpecification Provides a documentation for each Operator
"""

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
elemental_difference
====================

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @moe-ad, everything under operators/ is generated automatically using a template. We'll need to update the template for this to stay that way.

Copy link
Contributor

@PProfizi PProfizi Jan 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See here and here

Autogenerated DPF operator classes.
"""

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
elemental_difference_fc
=======================

Autogenerated DPF operator classes.
"""

Expand Down
Loading
Loading