doc: set up `autosummary`

BALOGHBence commented 1 month ago

Use autosummary in API doc.

Example: https://github.com/pydata/xarray/blob/main/doc/api.rst

For other examples, see the documentation of NumPy and SciPy.

BALOGHBence commented 1 month ago

.. _api_reference:

=============
API reference
=============

The reference guide contains a detailed description of the functions,
modules, and objects included in the library. The reference describes how the
methods work and which parameters can be used. It assumes that you have an
understanding of the key concepts.

Models
======

.. autosummary::
   :toctree: _autosummary
   :template: custom-module-template.rst

   sigmaepsilon.solid.fourier.problem.NavierProblem
   sigmaepsilon.solid.fourier.beam.NavierBeam
   sigmaepsilon.solid.fourier.plate.NavierPlate

Loads
=====

.. autosummary::
   :toctree: _autosummary
   :template: custom-module-template.rst

   sigmaepsilon.solid.fourier.loads.Float1d
   sigmaepsilon.solid.fourier.loads.Float2d
   sigmaepsilon.solid.fourier.loads.LoadDomainType
   sigmaepsilon.solid.fourier.loads.LoadValueType
   sigmaepsilon.solid.fourier.loads.LoadGroup
   sigmaepsilon.solid.fourier.loads.LoadCase
   sigmaepsilon.solid.fourier.loads.PointLoad
   sigmaepsilon.solid.fourier.loads.LineLoad
   sigmaepsilon.solid.fourier.loads.RectangleLoad

Results
=======

.. autosummary::
   :toctree: _autosummary
   :template: custom-module-template.rst

   sigmaepsilon.solid.fourier.result.LoadCaseResultLinStat
   sigmaepsilon.solid.fourier.result.BeamLoadCaseResultLinStat
   sigmaepsilon.solid.fourier.result.PlateLoadCaseResultLinStat

BALOGHBence commented 1 month ago

{{ fullname }}
{{ underline }}

.. currentmodule:: {{ module }}

.. automodule:: {{ fullname }}
   :members:
   :undoc-members:
   :show-inheritance:

BALOGHBence commented 1 month ago

Add autodoc_typehints = 'description' to conf.py.

sigma-epsilon / sigmaepsilon.solid.fourier

doc: set up `autosummary` #17