Skip to content

Commit e1e16f7

Browse files
committed
Fix docs rendering and add seealso links to PV kwargs to autosave API docs
1 parent acbe24a commit e1e16f7

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

docs/how-to/use-autosave-in-an-ioc.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Use `autosave` in an IOC
1+
Use `softioc.autosave` in an IOC
22
================================
33

44
`../tutorials/creating-an-ioc` shows how to create a pythonSoftIOC.

docs/reference/api.rst

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -198,6 +198,10 @@ and stderr streams, is sent directly to the terminal.
198198
.. seealso::
199199
`softioc.builder` for how to designate a field for autosave.
200200

201+
:ref:`autosave`, the keyword argument used to initialise PVs with the VAL field tracked by autosave.
202+
203+
`autosave_fields`, the keyword argument used to initialise PVs with designated fields tracked by autosave.
204+
201205
.. class:: Autosave
202206

203207
.. method:: __init__(autosave=True, autosave_fields=None)
@@ -328,10 +332,10 @@ and stderr streams, is sent directly to the terminal.
328332
.. seealso::
329333
`SetBlocking` for configuring a global default blocking value
330334

331-
.. _autosave_arg:
335+
.. _autosave:
332336

333-
`autosave`
334-
~~~~~~~~~~
337+
:ref:`autosave`
338+
~~~~~~~~~~~~~~~
335339

336340
Available on all record types. When set to `True` it marks the record
337341
value for automatic periodic backing up to a file. Set to `False` by

0 commit comments

Comments
 (0)