Skip to content

Commit

Permalink
added more links to pyqt docs in pydm widgets
Browse files Browse the repository at this point in the history
  • Loading branch information
YektaY committed Aug 24, 2023
1 parent 34f8a79 commit c382dd5
Show file tree
Hide file tree
Showing 15 changed files with 49 additions and 2 deletions.
2 changes: 0 additions & 2 deletions docs/source/widgets/archiver_timeplot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,6 @@ PyDMArchiverTimePlot

.. autoclass:: pydm.widgets.archiver_time_plot.PyDMArchiverTimePlot
:members:
:inherited-members:
:show-inheritance:

#######################
Expand All @@ -67,5 +66,4 @@ ArchivePlotCurveItem

.. autoclass:: pydm.widgets.archiver_time_plot.ArchivePlotCurveItem
:members:
:inherited-members:
:show-inheritance:
3 changes: 3 additions & 0 deletions docs/source/widgets/checkbox.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,6 @@ PyDMCheckbox
.. autoclass:: pydm.widgets.checkbox.PyDMCheckbox
:members:
:show-inheritance:

.. note::
See `QCheckBox Documentation <https://doc.qt.io/qtforpython-5/PySide2/QtWidgets/QCheckBox.html>`_ for all inherited properties and methods.
3 changes: 3 additions & 0 deletions docs/source/widgets/datetime_edit.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,6 @@ PyDMDateTimeEdit
.. autoclass:: pydm.widgets.datetime.PyDMDateTimeEdit
:members:
:show-inheritance:

.. note::
See `QDateTimeEdit Documentation <https://doc.qt.io/qtforpython-5/PySide2/QtWidgets/QDateTimeEdit.html>`_ for all inherited properties and methods.
4 changes: 4 additions & 0 deletions docs/source/widgets/embedded_display.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,7 @@ PyDMEmbeddedDisplay
.. autoclass:: pydm.widgets.embedded_display.PyDMEmbeddedDisplay
:members:
:show-inheritance:


.. note::
See `QFrame Documentation <https://doc.qt.io/qtforpython-5/PySide2/QtWidgets/QFrame.html>`_ for all inherited properties and methods.
3 changes: 3 additions & 0 deletions docs/source/widgets/enum_button.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,6 @@ PyDMEnumButton
.. autoclass:: pydm.widgets.enum_button.PyDMEnumButton
:members:
:show-inheritance:

.. note::
See `QWidget Documentation <https://doc.qt.io/qtforpython-5/PySide2/QtWidgets/QWidget.html>`_ for all inherited properties and methods.
4 changes: 4 additions & 0 deletions docs/source/widgets/enum_combo_box.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,7 @@ PyDMEnumComboBox
.. autoclass:: pydm.widgets.enum_combo_box.PyDMEnumComboBox
:members:
:show-inheritance:


.. note::
See `QComboBox Documentation <https://pyqtgraph.readthedocs.io/en/latest/api_reference/widgets/QComboBox.html>`_ for all inherited properties and methods.
4 changes: 4 additions & 0 deletions docs/source/widgets/frame.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,7 @@ PyDMFrame
.. autoclass:: pydm.widgets.frame.PyDMFrame
:members:
:show-inheritance:


.. note::
See `QFrame Documentation <https://doc.qt.io/qtforpython-5/PySide2/QtWidgets/QFrame.html>`_ for all inherited properties and methods.
4 changes: 4 additions & 0 deletions docs/source/widgets/line_edit.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,7 @@ PyDMLineEdit
:members:
:show-inheritance:
:exclude-members: DisplayFormat


.. note::
See `QLineEdit Documentation <https://pyqtgraph.readthedocs.io/en/latest/api_reference/widgets/QLineEdit.html>`_ for all inherited properties and methods.
3 changes: 3 additions & 0 deletions docs/source/widgets/pushbutton.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,6 @@ PyDMPushButton
:members:
:show-inheritance:


.. note::
See `QPushButton Documentation <https://doc.qt.io/qtforpython-5/PySide2/QtWidgets/QPushButton.html>`_ for all inherited properties and methods.
4 changes: 4 additions & 0 deletions docs/source/widgets/shell_command.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,7 @@ PyDMShellCommand
.. autoclass:: pydm.widgets.shell_command.PyDMShellCommand
:members:
:show-inheritance:


.. note::
See `QPushButton Documentation <https://doc.qt.io/qtforpython-5/PySide2/QtWidgets/QPushButton.html>`_ for all inherited properties and methods.
4 changes: 4 additions & 0 deletions docs/source/widgets/slider.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,7 @@ PyDMSlider
.. autoclass:: pydm.widgets.slider.PyDMSlider
:members:
:show-inheritance:


.. note::
See `QFrame Documentation <https://doc.qt.io/qtforpython-5/PySide2/QtWidgets/QFrame.html>`_ for all inherited properties and methods.
4 changes: 4 additions & 0 deletions docs/source/widgets/spinbox.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,7 @@ PyDMSpinbox
.. autoclass:: pydm.widgets.spinbox.PyDMSpinbox
:members:
:show-inheritance:


.. note::
See `QDoubleSpinBox Documentation <https://doc.qt.io/qtforpython-5/PySide2/QtWidgets/QDoubleSpinBox.html>`_ for all inherited properties and methods.
4 changes: 4 additions & 0 deletions docs/source/widgets/tab_widget.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,7 @@ API Documentation
.. autoclass:: pydm.widgets.tab_bar.PyDMTabWidget
:members:
:show-inheritance:


.. note::
See `QTabWidget Documentation <https://doc.qt.io/qtforpython-5/PySide2/QtWidgets/QTabWidget.html>`_ for all inherited properties and methods.
1 change: 1 addition & 0 deletions docs/source/widgets/template_repeater.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,6 @@ PyDMTemplateRepeater
:members:
:show-inheritance:


.. note::
See `QFrame Documentation <https://doc.qt.io/qtforpython-6.2/PySide6/QtWidgets/QFrame.html>`_ for all inherited properties and methods.
4 changes: 4 additions & 0 deletions docs/source/widgets/waveformtable.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,7 @@ PyDMWaveformTable
.. autoclass:: pydm.widgets.waveformtable.PyDMWaveformTable
:members:
:show-inheritance:


.. note::
See `QTableWidget Documentation <https://doc.qt.io/qtforpython-5/PySide2/QtWidgets/QTableWidget.html>`_ for all inherited properties and methods.

0 comments on commit c382dd5

Please sign in to comment.