doc files

simoneliuzzo · simoneliuzzo · commit 6bcb54723fdd · 2025-10-31T14:51:30.000+01:00
diff --git a/docs/api.rst b/docs/api.rst
@@ -0,0 +1,8 @@
+API
+===
+
+.. autosummary::
+   :toctree: generated
+   :recursive:
+
+   pyaml
diff --git a/docs/modules/arrays.rst b/docs/modules/arrays.rst
@@ -0,0 +1,11 @@
+ARRAYS
+********
+
+.. automodule:: pyaml.arrays.array
+    :members:
+
+.. automodule:: pyaml.arrays.magnet
+    :members:
+
+.. automodule:: pyaml.arrays.magnet_array
+    :members:
diff --git a/docs/modules/bpm.rst b/docs/modules/bpm.rst
@@ -0,0 +1,14 @@
+BPMS
+*****************
+
+.. automodule:: pyaml.bpm.bpm
+    :members:
+
+.. automodule:: pyaml.bpm.bpm_model
+    :members:
+
+.. automodule:: pyaml.bpm.bpm_tilt_offset_model
+    :members:
+
+.. automodule:: pyaml.bpm.bpm_simple_model
+    :members:
diff --git a/docs/modules/configuration.rst b/docs/modules/configuration.rst
@@ -0,0 +1,29 @@
+Configuration
+*****************
+
+.. automodule:: pyaml.configuration.fileloader
+    :members:
+
+.. automodule:: pyaml.configuration.factory
+    :members:
+    
+.. automodule:: pyaml.configuration.matrix
+    :members:
+
+.. automodule:: pyaml.configuration.curve
+    :members:
+
+.. automodule:: pyaml.configuration.csvcurve
+    :members:
+
+.. automodule:: pyaml.configuration.matrix
+    :members:
+    
+.. automodule:: pyaml.configuration.csvmatrix
+    :members:
+
+.. automodule:: pyaml.configuration.models
+    :members:
+
+.. automodule:: pyaml.configuration.config_exception
+    :members:
diff --git a/docs/modules/control.rst b/docs/modules/control.rst
@@ -0,0 +1,23 @@
+Control
+*********
+
+.. automodule:: pyaml.control.controlsystem
+    :members:
+
+.. automodule:: pyaml.control.device
+    :members:
+
+.. automodule:: pyaml.control.abstract_impl
+    :members:
+
+.. automodule:: pyaml.control.abstract
+    :members:
+
+.. automodule:: pyaml.control.deviceaccess
+    :members:
+
+.. automodule:: pyaml.control.deviceaccesslist
+    :members:
+
+.. automodule:: pyaml.control.readback_value
+    :members:
diff --git a/docs/modules/lattice.rst b/docs/modules/lattice.rst
@@ -0,0 +1,25 @@
+lattice
+************
+
+.. automodule:: pyaml.lattice.abstract_impl
+    :members:
+
+.. automodule:: pyaml.lattice.attribute_linker
+    :members:
+    
+.. automodule:: pyaml.lattice.element_holder
+    :members:
+
+.. automodule:: pyaml.lattice.element
+    :members:
+
+.. automodule:: pyaml.lattice.lattice_element_linker
+    :members:
+
+.. automodule:: pyaml.lattice.polynom_info
+    :members:
+
+.. automodule:: pyaml.lattice.simulator
+    :members:
+
+
diff --git a/docs/modules/magnet.rst b/docs/modules/magnet.rst
@@ -0,0 +1,5 @@
+magnets
+*********
+
+.. automodule:: pyaml.magnet
+    :members:
diff --git a/docs/modules/pyaml.rst b/docs/modules/pyaml.rst
@@ -0,0 +1,24 @@
+pyaml
+**************************
+
+.. automodule:: pyaml.pyaml
+    :members:
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+.. automodule:: pyaml.instrument
+    :members:
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+.. automodule:: pyaml.exception
+    :members:
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
diff --git a/docs/modules/rf.rst b/docs/modules/rf.rst
@@ -0,0 +1,9 @@
+RF
+****
+
+.. automodule:: pyaml.rf.rf_plant
+    :members:
+
+.. automodule:: pyaml.rf.rf_transmitter
+    :members:
+
