Skip to content

Commit

Permalink
Add Vertex element and region to the API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
adtzlr committed Feb 17, 2025
1 parent e252eaa commit 3fb4c48
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/felupe/element.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ This module provides classes for the finite element formulations.

.. autosummary::

Vertex
Line
Quad
Hexahedron
Expand Down Expand Up @@ -59,6 +60,11 @@ This module provides classes for the finite element formulations.
:undoc-members:
:show-inheritance:

.. autoclass:: felupe.Vertex
:members:
:undoc-members:
:show-inheritance:

.. autoclass:: felupe.Line
:members:
:undoc-members:
Expand Down
6 changes: 6 additions & 0 deletions docs/felupe/region.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ This module contains the definition of a region as well as a boundary region alo
RegionLagrange
RegionQuadBoundary
RegionHexahedronBoundary
RegionVertex

**Detailed API Reference**

Expand Down Expand Up @@ -127,6 +128,11 @@ This module contains the definition of a region as well as a boundary region alo
:show-inheritance:

.. autoclass:: felupe.RegionLagrange
:members:
:undoc-members:
:show-inheritance:

.. autoclass:: felupe.RegionVertex
:members:
:undoc-members:
:show-inheritance:

0 comments on commit 3fb4c48

Please sign in to comment.