Merge branch 'main' into 20-feature-implement-tunemonitor

Author: gubaidulinvadim

.github/workflows/documentation.yml

@@ -19,7 +19,7 @@ jobs:
     strategy:
       matrix:  # only lowest supported Python on latest ubuntu
         os: [ubuntu-latest]
-        python-version: [3.9]
+        python-version: [3.14]
 
     permissions:
       issues: write

docs/api.rst

@@ -0,0 +1,8 @@
+API
+===
+
+.. autosummary::
+   :toctree: generated
+   :recursive:
+
+   pyaml

docs/conf.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# pyAML documentation build configuration file, originally created for pySC: https://github.com/lmalina/pySC/blob/master/doc/conf.py
+# pyAML documentation build configuration file, 
 #
 # This file is execfile()d with the current directory set to its
 # containing dir.
@@ -48,11 +48,12 @@
               'sphinx.ext.doctest',
               'sphinx.ext.todo',
               'sphinx.ext.coverage',
-              'sphinx.ext.mathjax',
+              # 'sphinx.ext.mathjax',
               'sphinx.ext.viewcode',
               'sphinx.ext.githubpages',
               'sphinx.ext.napoleon',
               'sphinx.ext.autosectionlabel',
+              'sphinx.ext.autosummary',
               ]
 autosectionlabel_prefix_document = True
 autosectionlabel_maxdepth = 2
@@ -92,7 +93,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -120,6 +121,8 @@
     'display_version': True,
     'logo_only': True,
     'navigation_depth': 2,
+    "rightsidebar": "false",
+    "relbarbgcolor": "black"
 }
 
 

docs/index.rst

@@ -1,8 +1,11 @@
 pyAML documentation
-===================
+======================================
+
+.. contents:: Table of Contents
+    :depth: 3
 
 Introduction
-------------
+------------------------
 
 python Accelerator Middle Layer (pyAML) is a joint technology platform to develop common tools for control, tuning and development of storage rings, beam transport lines and linear accelerators.
 
@@ -17,25 +20,25 @@ With pyAML, it WILL be possible to (the software is at conceptualization stage):
 - many more features 
 
 Installation
-------------
+------------------------
 pip support will be provided later. 
 for the time being: 
 
 git clone https://github.com/python-accelerator-middle-layer/pyaml.git
 
 
 Collaboration community
-------------
+------------------------
 
 Discussion
-~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 `Mattermost <https://mattermost.hzdr.de/accelerator-middle-layer/channels/town-square>`_
 
 (please log in using Helmoltz ID, you will be prompt to access with your own lab/university credentials)
 
 Shared documents
-~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 to access the shared documents please ask S.Liuzzo for access rigths. 
 
@@ -45,12 +48,12 @@ https://www.overleaf.com/read/hnrqzhfpbvpp#ef8935
 to be added to editors list please write to S.Liuzzo
 
 Mailing list:
-~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~
 to be added to the pyAML mailing list please write to S.Liuzzo
 
 
-Package Reference
-=================
+Documentation
+----------------------
 
 .. toctree::
    :caption: Modules
@@ -61,7 +64,7 @@ Package Reference
 
 
 Indices and tables
-==================
+====================================
 
 * :ref:`genindex`
 * :ref:`modindex`

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:

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:

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:

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:

docs/modules/core_functions.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:
+
+