major documentation rework and packaging
Build Debian Packages / build (bookworm, debian12) (push) Failing after 7m59s
Build Debian Packages / build (bullseye, debian11) (push) Failing after 7m29s
Build Debian Packages / build (trixie, debian13) (push) Failing after 8m14s

This commit is contained in:
2026-03-25 14:36:24 +01:00
parent 75f32e1502
commit 3096e83a43
31 changed files with 2756 additions and 574 deletions
+21 -11
View File
@@ -3,30 +3,36 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
#####################
DAMARIS documentation
=====================
Add your content using ``reStructuredText`` syntax. See the
`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
documentation for details.
#####################
.. toctree::
:maxdepth: 2
:maxdepth: 3
:caption: Contents:
API Reference
-------------
manual
devel
#############
API Reference
#############
This API reference is generated from the source code.
***********
Experiments
~~~~~~~~~~~
***********
.. automodule:: damaris.experiments.Experiment
:members:
:undoc-members:
************
Data Objects
~~~~~~~~~~~~
************
.. automodule:: damaris.data.Accumulation
:members:
@@ -36,3 +42,7 @@ Data Objects
:members:
:undoc-members:
.. automodule:: damaris.data.DamarisFFT
:members:
:undoc-members: