From c31e9a3aff3ee8e984674dee0965ee7f1b6e2b8f Mon Sep 17 00:00:00 2001 From: wyzula-jan Date: Wed, 28 Aug 2024 12:19:54 +0200 Subject: [PATCH] docs: various bugs fixed --- docs/user/widgets/dock_area/bec_dock_area.md | 6 ++++-- .../widgets/position_indicator/position_indicator.md | 9 +-------- docs/user/widgets/spinner/spinner.md | 7 ------- docs/user/widgets/waveform/waveform_widget.md | 6 +++--- 4 files changed, 8 insertions(+), 20 deletions(-) diff --git a/docs/user/widgets/dock_area/bec_dock_area.md b/docs/user/widgets/dock_area/bec_dock_area.md index 78d74d82..589601ef 100644 --- a/docs/user/widgets/dock_area/bec_dock_area.md +++ b/docs/user/widgets/dock_area/bec_dock_area.md @@ -2,7 +2,7 @@ # BECDockArea -```{tab} Overview +````{tab} Overview [`BECDockArea`](/api_reference/_autosummary/bec_widgets.cli.client.BECDockArea) is a powerful and flexible container designed to host various widgets and docks within a grid layout. It provides an environment for organizing and managing complex user interfaces, making it ideal for applications that require multiple tools and data visualizations to be displayed simultaneously. BECDockArea is particularly useful for embedding not only visualization tools but also other interactive components, allowing users to tailor their workspace to their specific needs. @@ -10,9 +10,11 @@ - **State Persistence**: Save and restore the state of the dock area, enabling consistent user experiences across sessions. - **Dock Customization**: Add docks with customizable positions, names, and behaviors, such as floating or closable docks. - **Integration with Widgets**: Integrate various widgets like [`WaveformWidget`](user.widgets.waveform_widget), [`ImageWidget`](user.widgets.image_widget), and [`MotorMapWidget`](user.widgets.motor_map) into `BECDockArea`, either as standalone tools or as part of a more complex interface. -``` + +**BEC Dock Area Components Schema** ![BECDockArea.png](BECDockArea.png) +```` ````{tab} Examples - CLI In the following examples, we will use `BECIPythonClient` as the main object to interact with the `BECDockArea`. These tutorials focus on how to work with the `BECDockArea` framework, such as adding and removing docks, saving and restoring layouts, and managing the docked widgets. By default the `BECDockArea` is refered as `gui` in `BECIPythonClient`. For more detailed examples of each individual component, please refer to the example sections of each individual [`widget`](user.widgets). diff --git a/docs/user/widgets/position_indicator/position_indicator.md b/docs/user/widgets/position_indicator/position_indicator.md index 7e14a955..dfc97ef2 100644 --- a/docs/user/widgets/position_indicator/position_indicator.md +++ b/docs/user/widgets/position_indicator/position_indicator.md @@ -66,11 +66,4 @@ The `PositionIndicator` can be added to your GUI layout using `QtDesigner`. Once self.position_indicator.on_position_update(new_position_value) ``` -```` - -````{tab} API - -```{eval-rst} -.. include:: /api_reference/_autosummary/bec_widgets.cli.client.PositionIndicator.rst -``` -```` +```` \ No newline at end of file diff --git a/docs/user/widgets/spinner/spinner.md b/docs/user/widgets/spinner/spinner.md index 5064f2e6..62ad8f08 100644 --- a/docs/user/widgets/spinner/spinner.md +++ b/docs/user/widgets/spinner/spinner.md @@ -65,11 +65,4 @@ self.spinner_widget.start() self.spinner_widget.stop() ``` -```` - -````{tab} API - -```{eval-rst} -.. include:: /api_reference/_autosummary/bec_widgets.widgets.spinner.spinner.SpinnerWidget.rst -``` ```` \ No newline at end of file diff --git a/docs/user/widgets/waveform/waveform_widget.md b/docs/user/widgets/waveform/waveform_widget.md index 8eeae385..5a4b5d60 100644 --- a/docs/user/widgets/waveform/waveform_widget.md +++ b/docs/user/widgets/waveform/waveform_widget.md @@ -19,11 +19,11 @@ The Waveform Widget is used to display 1D detector signals. The widget is direct ````{tab} Examples - CLI -`WaveformWidget` can be embedded in both `BECFigure` and `BECDockArea`, or used as an individual component in your application through `BECDesigner`. However, the command-line API is the same for all cases. +`WaveformWidget` can be embedded in both [`BECFigure`](user.widgets.bec_figure) and [`BECDockArea`](user.widgets.bec_dock_area), or used as an individual component in your application through `BECDesigner`. However, the command-line API is the same for all cases. ## Example 1 - Adding Waveform Widget to BECFigure -In this example, we will demonstrate how to add two different `WaveformWidgets` into a single `BECFigure` widget. +In this example, we will demonstrate how to add two different `WaveformWidgets` into a single [`BECFigure`](user.widgets.bec_figure) widget. ```python # Add new dock with BECFigure widget @@ -36,7 +36,7 @@ plt2 = fig.plot(x_name='samx', y_name='bpm3i') ## Example 2 - Adding Waveform Widget as a dock with BECDockArea -Adding `WaveformWidget` into a `BECDockArea` is similar to adding any other widget. The widget has the same API as the one in BECFigure; however, as an independent widget outside BECFigure, it has its own toolbar, allowing users to configure the widget without needing CLI commands. +Adding `WaveformWidget` into a [`BECDockArea`](user.widgets.bec_dock_area) is similar to adding any other widget. The widget has the same API as the one in BECFigure; however, as an independent widget outside BECFigure, it has its own toolbar, allowing users to configure the widget without needing CLI commands. ```python # Add new WaveformWidgets to the BECDockArea