diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 0cfe5026..d77783d6 100644 --- a/.github/workflows/documentation.yml +++ b/.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 diff --git a/docs/api.rst b/docs/api.rst new file mode 100644 index 00000000..b68bd568 --- /dev/null +++ b/docs/api.rst @@ -0,0 +1,8 @@ +API +=== + +.. autosummary:: + :toctree: generated + :recursive: + + pyaml \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 9dcc6466..167114d9 100644 --- a/docs/conf.py +++ b/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" } diff --git a/docs/index.rst b/docs/index.rst index 742c7411..ef8b087e 100644 --- a/docs/index.rst +++ b/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,7 +20,7 @@ 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: @@ -25,17 +28,17 @@ git clone https://github.com/python-accelerator-middle-layer/pyaml.git Collaboration community ------------- +------------------------ Discussion -~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~ `Mattermost `_ (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` diff --git a/docs/modules/arrays.rst b/docs/modules/arrays.rst new file mode 100644 index 00000000..bccaed2c --- /dev/null +++ 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 new file mode 100644 index 00000000..f5ff7867 --- /dev/null +++ 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: \ No newline at end of file diff --git a/docs/modules/configuration.rst b/docs/modules/configuration.rst new file mode 100644 index 00000000..dc44a648 --- /dev/null +++ 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 new file mode 100644 index 00000000..62cf3dbb --- /dev/null +++ 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/core_functions.rst b/docs/modules/core_functions.rst deleted file mode 100644 index f40da13e..00000000 --- a/docs/modules/core_functions.rst +++ /dev/null @@ -1,8 +0,0 @@ -Core functions -************************** - -.. automodule:: pyAML.pyaml - :members: - -.. automodule:: pyAML.device - :members: diff --git a/docs/modules/lattice.rst b/docs/modules/lattice.rst new file mode 100644 index 00000000..781c017e --- /dev/null +++ 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 new file mode 100644 index 00000000..93f59016 --- /dev/null +++ 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 new file mode 100644 index 00000000..fd258108 --- /dev/null +++ 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 new file mode 100644 index 00000000..2d5a3b62 --- /dev/null +++ b/docs/modules/rf.rst @@ -0,0 +1,9 @@ +RF +**** + +.. automodule:: pyaml.rf.rf_plant + :members: + +.. automodule:: pyaml.rf.rf_transmitter + :members: + diff --git a/docs/modules/tuning_tools.rst b/docs/modules/tuning_tools.rst index c831b829..858702b7 100644 --- a/docs/modules/tuning_tools.rst +++ b/docs/modules/tuning_tools.rst @@ -1,11 +1,11 @@ -Tuning Tools -************************** +Tuning tools +*************** -.. automodule:: tuning_tools.LOCO.loco +.. automodule:: pyaml.tuning_tools.LOCO.loco :members: -.. automodule:: tuning_tools.SOFB.sofb +.. automodule:: pyaml.tuning_tools.SOFB.sofb :members: -.. automodule:: tuning_tools.TUNE.tune +.. automodule:: pyaml.tuning_tools.TUNE.tune :members: diff --git a/docs/requirements.txt b/docs/requirements.txt index 94c3dcfa..1f414a18 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -sphinx==8.1.3 +sphinx==8.2.3 sphinx-book-theme==1.1.3 sphinx-copybutton==0.5.2 sphinx-design==0.6.1