Skip to content

Commit

Permalink
fix weird dataclass args formatting, show base classes, add watch to…
Browse files Browse the repository at this point in the history
… sphinx running doc
  • Loading branch information
rerpha committed Sep 25, 2024
1 parent 20fc5eb commit f6137ea
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 5 deletions.
1 change: 1 addition & 0 deletions doc/_templates/custom-module-template.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@

.. automodule:: {{ fullname }}
:members:
:show-inheritance:

{% block modules %}
{% if modules %}
Expand Down
2 changes: 1 addition & 1 deletion doc/dev/set_up_dev_environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,4 @@ the type of block expected by `demo_plan`

To build the sphinx documentation locally run `sphinx-build doc _build` from the root of the repo. The generated output will be in the _build directory.

If you want to preview changes live, you can run `sphinx-autobuild doc _build` from the root of the repo instead which will start a local, hot-reloadable web server.
If you want to preview changes live, you can run `sphinx-autobuild doc _build --watch src` from the root of the repo instead which will start a local, hot-reloadable web server. This should rebuild the documentation whenever you change anything in src, which in turn will rebuild the API reference pages.
12 changes: 8 additions & 4 deletions src/ibex_bluesky_core/devices/block.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,12 @@
class BlockWriteConfig(Generic[T]):
"""Configuration settings for writing to blocks.
use_completion_callback: Whether to wait for an EPICS completion callback while setting
use_completion_callback:
Whether to wait for an EPICS completion callback while setting
this block. Defaults to true, which is appropriate for most blocks.
set_success_func: An arbitrary function which is called to decide whether the block has
set_success_func:
An arbitrary function which is called to decide whether the block has
set successfully yet or not. The function takes (setpoint, actual) as arguments and
should return true if the value has successfully set and is "ready", or False otherwise.
Expand All @@ -60,13 +62,15 @@ def check(setpoint: T, actual: T) -> bool:
Defaults to None, which means no check is applied.
set_timeout_s: A timeout, in seconds, on the value being set successfully. The timeout
set_timeout_s:
A timeout, in seconds, on the value being set successfully. The timeout
applies to the EPICS completion callback (if enabled) and the set success function
(if provided), and excludes any configured settle time.
Defaults to None, which means no timeout.
settle_time_s: A wait time, in seconds, which is unconditionally applied just before the set
settle_time_s:
A wait time, in seconds, which is unconditionally applied just before the set
status is marked as complete. Defaults to zero.
"""
Expand Down

0 comments on commit f6137ea

Please sign in to comment.