DOC: Add doc page for multistate widget

slaclab · Oct 25, 2023 · 893d11d · 893d11d
1 parent 28d6bd6
commit 893d11d
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 2 deletions.
diff --git a/docs/source/widgets/PyDMWidget.rst b/docs/source/widgets/PyDMWidget.rst
@@ -10,7 +10,7 @@ API Documentation
    :show-inheritance:
 
 PyDMToolTip Instructions
-=================
+========================
 The PyDMToolTip property field takes a string. In the PyDMToolTip property field, the user can include the tag $(pv_value) to get the value of the
 channel displayed on the tool tip.
 

diff --git a/docs/source/widgets/index.rst b/docs/source/widgets/index.rst
@@ -10,6 +10,7 @@ Display Widgets
    :maxdepth: 1
 
    byte.rst
+   multistate.rst
    datetime_label.rst
    image.rst
    label.rst
@@ -73,7 +74,6 @@ Base Widgets
 
 Utilities
 ---------
-
 .. toctree::
    :maxdepth: 1
 

diff --git a/docs/source/widgets/multistate.rst b/docs/source/widgets/multistate.rst
@@ -0,0 +1,11 @@
+#######################
+PyDMMultiStateIndicator
+#######################
+
+.. autoclass:: pydm.widgets.byte.PyDMMultiStateIndicator
+   :members:
+   :show-inheritance:
+
+
+.. note::
+   See `QWidget Documentation <https://doc.qt.io/qtforpython-5/PySide2/QtWidgets/QWidget.html>`_ for all inherited properties and methods.