Skip to content

Add titles for the geometries modules in the api ref #1848

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.

Sign up for GitHub

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
Nov 13, 2024
Merged

Add titles for the geometries modules in the api ref #1848

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f2298b2
add title and ref in the geometry.py api
luisaFelixSalles Nov 4, 2024
1bc3004
add title and ref in the geometry_factory.py api
luisaFelixSalles Nov 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion src/ansys/dpf/core/geometry.py
View file
Open in desktop
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
View file
Open in desktop
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