added sphinx documentation

2026-03-23 17:07:51 +01:00
parent 27466fe2d6
commit 75f32e1502
6 changed files with 161 additions and 76 deletions
@@ -0,0 +1,38 @@
+.. DAMARIS documentation master file, created by
+   sphinx-quickstart on Mon Mar 23 15:55:16 2026.
+   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
+   :caption: Contents:
+
+API Reference
+-------------
+
+Experiments
+~~~~~~~~~~~
+
+.. automodule:: damaris.experiments.Experiment
+   :members:
+   :undoc-members:
+
+Data Objects
+~~~~~~~~~~~~
+
+.. automodule:: damaris.data.Accumulation
+   :members:
+   :undoc-members:
+
+.. automodule:: damaris.data.ADC_Result
+   :members:
+   :undoc-members:
+