Skip to content

Commit

Permalink
Add titles for the geometries modules in the api ref (#1848)
Browse files Browse the repository at this point in the history
* add title and ref in the geometry.py api

* add title and ref in the geometry_factory.py api
  • Loading branch information
luisaFelixSalles authored Nov 13, 2024
1 parent a040949 commit 5f83c83
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 2 deletions.
9 changes: 8 additions & 1 deletion src/ansys/dpf/core/geometry.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,14 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

"""Module containing the different geometry objects."""
"""
.. _ref_geometry:
Geometry
========
Module containing the different geometry objects.
"""

from ansys.dpf import core as dpf

Expand Down
9 changes: 8 additions & 1 deletion src/ansys/dpf/core/geometry_factory.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,14 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

"""Geometry factory module containing functions to create the different geometries."""
"""
.. _ref_geometry_factory:
Geometry Factory
================
Geometry factory module containing functions to create the different geometries.
"""

import numpy as np

Expand Down

0 comments on commit 5f83c83

Please sign in to comment.