Add more autodoc

yamcs · Jun 2, 2024 · 5407642 · 5407642
1 parent 930a12b
commit 5407642
Show file tree

Hide file tree

Showing 18 changed files with 697 additions and 76 deletions.
diff --git a/docs/alarms.rst b/docs/alarms.rst
@@ -0,0 +1,30 @@
+Alarms
+======
+
+AlarmLevel
+----------
+
+.. autoclass:: yamcs.pymdb.AlarmLevel
+   :members:
+   :member-order: bysource
+
+
+Alarm
+-----
+
+.. autoclass:: yamcs.pymdb.Alarm
+   :members:
+
+
+EnumerationAlarm
+----------------
+
+.. autoclass:: yamcs.pymdb.EnumerationAlarm
+   :members:
+
+
+ThresholdAlarm
+--------------
+
+.. autoclass:: yamcs.pymdb.ThresholdAlarm
+   :members:
diff --git a/docs/algorithms.rst b/docs/algorithms.rst
@@ -1,3 +1,64 @@
 Algorithms
 ==========
 
+Algorithm
+---------
+
+.. autoclass:: yamcs.pymdb.Algorithm
+   :members:
+
+
+InputParameter
+--------------
+
+.. autoclass:: yamcs.pymdb.InputParameter
+   :members:
+
+
+OutputParameter
+---------------
+
+.. autoclass:: yamcs.pymdb.OutputParameter
+   :members:
+
+
+Trigger
+-------
+
+.. autoclass:: yamcs.pymdb.Trigger
+   :members:
+
+
+ParameterTrigger
+----------------
+
+.. autoclass:: yamcs.pymdb.ParameterTrigger
+   :members:
+
+
+ContainerTrigger
+----------------
+
+.. autoclass:: yamcs.pymdb.ContainerTrigger
+   :members:
+
+
+UnnamedAlgorithm
+----------------
+
+.. autoclass:: yamcs.pymdb.UnnamedAlgorithm
+   :members:
+
+
+UnnamedJavaAlgorithm
+--------------------
+
+.. autoclass:: yamcs.pymdb.UnnamedJavaAlgorithm
+   :members:
+
+
+UnnamedJavaScriptAlgorithm
+--------------------------
+
+.. autoclass:: yamcs.pymdb.UnnamedJavaScriptAlgorithm
+   :members:
diff --git a/docs/ancillary.rst b/docs/ancillary.rst
@@ -0,0 +1,15 @@
+Ancillary
+=========
+
+AncillaryData
+-------------
+
+.. autoclass:: yamcs.pymdb.AncillaryData
+   :members:
+
+
+AncillaryDataItem
+-----------------
+
+.. autoclass:: yamcs.pymdb.AncillaryDataItem
+   :members:
diff --git a/docs/calibrators.rst b/docs/calibrators.rst
@@ -0,0 +1,22 @@
+Calibrators
+===========
+
+Calibrator
+----------
+
+.. autoclass:: yamcs.pymdb.Calibrator
+   :members:
+
+
+Polynomial
+----------
+
+.. autoclass:: yamcs.pymdb.Polynomial
+   :members:
+
+
+Interpolate
+-----------
+
+.. autoclass:: yamcs.pymdb.Interpolate
+   :members:
diff --git a/docs/commands.rst b/docs/commands.rst
@@ -1,3 +1,107 @@
 Commands
 ========
 
+Command
+-------
+
+.. autoclass:: yamcs.pymdb.Command
+   :members:
+
+
+CommandLevel
+------------
+
+.. autoclass:: yamcs.pymdb.CommandLevel
+   :members:
+   :member-order: bysource
+
+
+Argument
+--------
+
+.. autoclass:: yamcs.pymdb.Argument
+   :members:
+
+
+AbsoluteTimeArgument
+--------------------
+
+.. autoclass:: yamcs.pymdb.AbsoluteTimeArgument
+   :members:
+
+
+AggregateArgument
+-----------------
+
+.. autoclass:: yamcs.pymdb.AggregateArgument
+   :members:
+
+
+ArrayArgument
+-------------
+
+.. autoclass:: yamcs.pymdb.ArrayArgument
+   :members:
+
+
+BinartyArgument
+---------------
+
+.. autoclass:: yamcs.pymdb.BinaryArgument
+   :members:
+
+
+BooleanArgument
+---------------
+
+.. autoclass:: yamcs.pymdb.BooleanArgument
+   :members:
+
+
+EnumeratedArgument
+------------------
+
+.. autoclass:: yamcs.pymdb.EnumeratedArgument
+   :members:
+
+
+FloatArgument
+-------------
+
+.. autoclass:: yamcs.pymdb.FloatArgument
+   :members:
+
+
+IntegerArgument
+------------------
+
+.. autoclass:: yamcs.pymdb.IntegerArgument
+   :members:
+
+
+StringArgument
+--------------
+
+.. autoclass:: yamcs.pymdb.StringArgument
+   :members:
+
+
+ArgumentEntry
+-------------
+
+.. autoclass:: yamcs.pymdb.ArgumentEntry
+   :members:
+
+
+FixedValueEntry
+---------------
+
+.. autoclass:: yamcs.pymdb.FixedValueEntry
+   :members:
+
+
+TransmissionConstraint
+----------------------
+
+.. autoclass:: yamcs.pymdb.TransmissionConstraint
+   :members:
diff --git a/docs/conf.py b/docs/conf.py
@@ -47,7 +47,7 @@
 latex_documents = [
     (
         master_doc,
-        "pymdb.tex",
+        f"python-yamcs-pymdb-{release}.tex",
         "Yamcs PyMDB",
         "Space Applications Services",
         "manual",
@@ -56,6 +56,8 @@
 
 autoclass_content = "both"
 autodoc_class_signature = "separated"
+autodoc_typehints_format = "short"
+python_use_unqualified_type_names = True
 autodoc_default_options = {
     # "member-order": "bysource",
     "undoc-members": True,

diff --git a/docs/containers.rst b/docs/containers.rst
@@ -1,3 +1,22 @@
 Containers
 ==========
 
+Container
+---------
+
+.. autoclass:: yamcs.pymdb.Container
+   :members:
+
+
+ParameterEntry
+--------------
+
+.. autoclass:: yamcs.pymdb.ParameterEntry
+   :members:
+
+
+ContainerEntry
+--------------
+
+.. autoclass:: yamcs.pymdb.ContainerEntry
+   :members: