Skip to content

Commit 5f83c83

Browse files
Add titles for the geometries modules in the api ref (#1848)
* add title and ref in the geometry.py api * add title and ref in the geometry_factory.py api
1 parent a040949 commit 5f83c83

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

src/ansys/dpf/core/geometry.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,14 @@
2020
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
2121
# SOFTWARE.
2222

23-
"""Module containing the different geometry objects."""
23+
"""
24+
.. _ref_geometry:
25+
26+
Geometry
27+
========
28+
Module containing the different geometry objects.
29+
30+
"""
2431

2532
from ansys.dpf import core as dpf
2633

src/ansys/dpf/core/geometry_factory.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,14 @@
2020
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
2121
# SOFTWARE.
2222

23-
"""Geometry factory module containing functions to create the different geometries."""
23+
"""
24+
.. _ref_geometry_factory:
25+
26+
Geometry Factory
27+
================
28+
Geometry factory module containing functions to create the different geometries.
29+
30+
"""
2431

2532
import numpy as np
2633

0 commit comments

Comments
 (0)