Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ python:

submodules:
include: all
recursive: true
recursive: true
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ test: Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
5 changes: 2 additions & 3 deletions docs/api/pyaml.accelerator.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,10 @@

.. automodule:: pyaml.accelerator


.. rubric:: Classes

.. autosummary::

Accelerator
ConfigModel

5 changes: 2 additions & 3 deletions docs/api/pyaml.arrays.array.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,10 @@ pyaml.arrays.array

.. automodule:: pyaml.arrays.array


.. rubric:: Classes

.. autosummary::

ArrayConfig
ArrayConfigModel

5 changes: 2 additions & 3 deletions docs/api/pyaml.arrays.bpm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,10 @@ pyaml.arrays.bpm

.. automodule:: pyaml.arrays.bpm


.. rubric:: Classes

.. autosummary::

BPM
ConfigModel

5 changes: 2 additions & 3 deletions docs/api/pyaml.arrays.bpm_array.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,11 @@ pyaml.arrays.bpm\_array

.. automodule:: pyaml.arrays.bpm_array


.. rubric:: Classes

.. autosummary::

BPMArray
RWBPMPosition
RWBPMSinglePosition

5 changes: 2 additions & 3 deletions docs/api/pyaml.arrays.cfm_magnet.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,10 @@ pyaml.arrays.cfm\_magnet

.. automodule:: pyaml.arrays.cfm_magnet


.. rubric:: Classes

.. autosummary::

CombinedFunctionMagnet
ConfigModel

5 changes: 2 additions & 3 deletions docs/api/pyaml.arrays.cfm_magnet_array.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,11 @@ pyaml.arrays.cfm\_magnet\_array

.. automodule:: pyaml.arrays.cfm_magnet_array


.. rubric:: Classes

.. autosummary::

CombinedFunctionMagnetArray
RWMagnetHardwares
RWMagnetStrengths

5 changes: 2 additions & 3 deletions docs/api/pyaml.arrays.element.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,10 @@ pyaml.arrays.element

.. automodule:: pyaml.arrays.element


.. rubric:: Classes

.. autosummary::

ConfigModel
Element

5 changes: 2 additions & 3 deletions docs/api/pyaml.arrays.element_array.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@ pyaml.arrays.element\_array

.. automodule:: pyaml.arrays.element_array


.. rubric:: Classes

.. autosummary::

ElementArray

5 changes: 2 additions & 3 deletions docs/api/pyaml.arrays.magnet.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,10 @@ pyaml.arrays.magnet

.. automodule:: pyaml.arrays.magnet


.. rubric:: Classes

.. autosummary::

ConfigModel
Magnet

5 changes: 2 additions & 3 deletions docs/api/pyaml.arrays.magnet_array.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,11 @@ pyaml.arrays.magnet\_array

.. automodule:: pyaml.arrays.magnet_array


.. rubric:: Classes

.. autosummary::

MagnetArray
RWMagnetHardware
RWMagnetStrength

2 changes: 1 addition & 1 deletion docs/api/pyaml.arrays.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

.. automodule:: pyaml.arrays


.. rubric:: Modules

.. autosummary::
Expand Down
5 changes: 2 additions & 3 deletions docs/api/pyaml.arrays.serialized_magnet.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,10 @@ pyaml.arrays.serialized\_magnet

.. automodule:: pyaml.arrays.serialized_magnet


.. rubric:: Classes

.. autosummary::

ConfigModel
SerializedMagnets

5 changes: 2 additions & 3 deletions docs/api/pyaml.arrays.serialized_magnet_array.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,11 @@ pyaml.arrays.serialized\_magnet\_array

.. automodule:: pyaml.arrays.serialized_magnet_array


.. rubric:: Classes

.. autosummary::

RWMagnetHardwares
RWMagnetStrengths
SerializedMagnetsArray

5 changes: 2 additions & 3 deletions docs/api/pyaml.bpm.bpm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,10 @@ pyaml.bpm.bpm

.. automodule:: pyaml.bpm.bpm


.. rubric:: Classes

.. autosummary::

BPM
ConfigModel

5 changes: 2 additions & 3 deletions docs/api/pyaml.bpm.bpm_model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@ pyaml.bpm.bpm\_model

.. automodule:: pyaml.bpm.bpm_model


.. rubric:: Classes

.. autosummary::

BPMModel

5 changes: 2 additions & 3 deletions docs/api/pyaml.bpm.bpm_simple_model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,10 @@ pyaml.bpm.bpm\_simple\_model

.. automodule:: pyaml.bpm.bpm_simple_model


.. rubric:: Classes

.. autosummary::

BPMSimpleModel
ConfigModel

5 changes: 2 additions & 3 deletions docs/api/pyaml.bpm.bpm_tiltoffset_model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,10 @@ pyaml.bpm.bpm\_tiltoffset\_model

.. automodule:: pyaml.bpm.bpm_tiltoffset_model


.. rubric:: Classes

.. autosummary::

BPMTiltOffsetModel
ConfigModel

2 changes: 1 addition & 1 deletion docs/api/pyaml.bpm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

.. automodule:: pyaml.bpm


.. rubric:: Modules

.. autosummary::
Expand Down
5 changes: 2 additions & 3 deletions docs/api/pyaml.common.abstract.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,13 @@ pyaml.common.abstract

.. automodule:: pyaml.common.abstract


.. rubric:: Classes

.. autosummary::

RWMapper
ReadFloatArray
ReadFloatScalar
ReadWriteFloatArray
ReadWriteFloatScalar

5 changes: 2 additions & 3 deletions docs/api/pyaml.common.abstract_aggregator.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@ pyaml.common.abstract\_aggregator

.. automodule:: pyaml.common.abstract_aggregator


.. rubric:: Classes

.. autosummary::

ScalarAggregator

2 changes: 0 additions & 2 deletions docs/api/pyaml.common.constants.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,3 @@ pyaml.common.constants
======================

.. automodule:: pyaml.common.constants


5 changes: 2 additions & 3 deletions docs/api/pyaml.common.element.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,10 @@ pyaml.common.element

.. automodule:: pyaml.common.element


.. rubric:: Classes

.. autosummary::

Element
ElementConfigModel

5 changes: 2 additions & 3 deletions docs/api/pyaml.common.element_holder.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@ pyaml.common.element\_holder

.. automodule:: pyaml.common.element_holder


.. rubric:: Classes

.. autosummary::

ElementHolder

5 changes: 2 additions & 3 deletions docs/api/pyaml.common.exception.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,10 @@ pyaml.common.exception

.. automodule:: pyaml.common.exception


.. rubric:: Exceptions

.. autosummary::

PyAMLConfigException
PyAMLException

2 changes: 1 addition & 1 deletion docs/api/pyaml.common.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

.. automodule:: pyaml.common


.. rubric:: Modules

.. autosummary::
Expand Down
5 changes: 2 additions & 3 deletions docs/api/pyaml.configuration.csvcurve.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,10 @@ pyaml.configuration.csvcurve

.. automodule:: pyaml.configuration.csvcurve


.. rubric:: Classes

.. autosummary::

CSVCurve
ConfigModel

5 changes: 2 additions & 3 deletions docs/api/pyaml.configuration.csvmatrix.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,10 @@ pyaml.configuration.csvmatrix

.. automodule:: pyaml.configuration.csvmatrix


.. rubric:: Classes

.. autosummary::

CSVMatrix
ConfigModel

Loading