T controller tutorial and improve documentation

add tutorial for Berlin hands-on workshop

+ improve the documentation (hints for structure welcome)
+ remove 'optional' parameter property
  (is not yet used - should not appear in doc)
+ added test property in frappy_demo.cryo alters Parameter class
  ('test' property appears in Parameter doc)

Change-Id: I3ea08f955a92f72451fd23a5ff00d1185c7fb00e
This commit is contained in:
2023-01-26 16:34:48 +01:00
parent a39db9a35d
commit e1d5170a90
21 changed files with 956 additions and 126 deletions

View File

@ -1,9 +1,18 @@
Reference
---------
Core
....
For convenience everything documented on this page may also be
imported from the frappy.core module.
Module Base Classes
...................
.. _done unique:
.. autodata:: frappy.modules.Done
.. autoclass:: frappy.modules.Module
@ -27,21 +36,61 @@ Parameters, Commands and Properties
.. autoclass:: frappy.modules.Attached
:show-inheritance:
Access method decorators
........................
.. autofunction:: frappy.rwhandler.nopoll
.. _datatypes:
Datatypes
.........
.. autoclass:: frappy.datatypes.FloatRange
.. autoclass:: frappy.datatypes.IntRange
.. autoclass:: frappy.datatypes.BoolType
.. autoclass:: frappy.datatypes.ScaledInteger
.. autoclass:: frappy.datatypes.EnumType
.. autoclass:: frappy.datatypes.StringType
.. autoclass:: frappy.datatypes.TupleOf
.. autoclass:: frappy.datatypes.ArrayOf
.. autoclass:: frappy.datatypes.StructOf
.. autoclass:: frappy.datatypes.BLOBType
:members: __call__
.. autoclass:: frappy.datatypes.IntRange
:members: __call__
.. autoclass:: frappy.datatypes.BoolType
:members: __call__
.. autoclass:: frappy.datatypes.ScaledInteger
:members: __call__
.. autoclass:: frappy.datatypes.EnumType
:members: __call__
.. autoclass:: frappy.datatypes.StringType
:members: __call__
.. autoclass:: frappy.datatypes.TupleOf
:members: __call__
.. autoclass:: frappy.datatypes.ArrayOf
:members: __call__
.. autoclass:: frappy.datatypes.StructOf
:members: __call__
.. autoclass:: frappy.datatypes.BLOBType
:members: __call__
.. autoclass:: frappy.datatypes.DataTypeType
:members: __call__
.. autoclass:: frappy.datatypes.ValueType
:members: __call__
.. autoclass:: frappy.datatypes.NoneOr
:members: __call__
.. autoclass:: frappy.datatypes.OrType
:members: __call__
.. autoclass:: frappy.datatypes.LimitsType
:members: __call__
Communication
@ -51,6 +100,9 @@ Communication
:show-inheritance:
:members: communicate
.. autoclass:: frappy.io.IOBase
:show-inheritance:
.. autoclass:: frappy.io.StringIO
:show-inheritance:
:members: communicate, multicomm
@ -62,6 +114,12 @@ Communication
.. autoclass:: frappy.io.HasIO
:show-inheritance:
.. autoclass:: frappy.lib.asynconn.AsynTcp
:show-inheritance:
.. autoclass:: frappy.lib.asynconn.AsynSerial
:show-inheritance:
.. autoclass:: frappy.rwhandler.ReadHandler
:show-inheritance:
:members:
@ -85,5 +143,4 @@ Exception classes
.. automodule:: frappy.errors
:members:
.. include:: server.rst
.. include:: configuration.rst