Skip to content

Commit a873d0e

Browse files
Remove all unncecessary :role: tags that I can find.
1 parent 338be4d commit a873d0e

File tree

5 files changed

+23
-27
lines changed

5 files changed

+23
-27
lines changed

docs/how-to/make-publishable-ioc.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Create a Publishable IOC
22
========================
33

4-
As seen in :doc:`../tutorials/creating-an-ioc`, a single Python script can be an IOC.
4+
As seen in `../tutorials/creating-an-ioc`, a single Python script can be an IOC.
55
It is also possible (and the most common situation) to have an entire Python module
66
comprising an IOC. This guide explains both, as well as how to publish an IOC within
77
the DLS environment.

docs/how-to/read-data-from-ioc.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ This guide explains how to read data from an IOC in a separate Python program.
88
These are used by EPICS for channel access to the PVs.
99

1010

11-
To start, run the :mod:`cothread` IOC from :doc:`../tutorials/creating-an-ioc` or the
12-
:mod:`asyncio` IOC from :doc:`use-asyncio-in-an-ioc` and leave it running at the
11+
To start, run the `cothread` IOC from `../tutorials/creating-an-ioc` or the
12+
`asyncio` IOC from `use-asyncio-in-an-ioc` and leave it running at the
1313
interactive shell.
1414

1515
We will read data from that IOC using this script:

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,32 @@ Use `asyncio` in an IOC
22
=======================
33

44
There are two libraries available for asynchronous operations in PythonIOC:
5-
:mod:`cothread` and :mod:`asyncio`. This guide shows how to use the latter in
5+
`cothread` and `asyncio`. This guide shows how to use the latter in
66
an IOC.
77

88
.. note::
9-
This page only explains the differences between using :mod:`cothread` and :mod:`asyncio`.
10-
For more thorough explanation of the IOC itself see :doc:`../tutorials/creating-an-ioc`
9+
This page only explains the differences between using `cothread` and `asyncio`.
10+
For more thorough explanation of the IOC itself see `../tutorials/creating-an-ioc`
1111

1212
.. literalinclude:: ../examples/example_asyncio_ioc.py
1313

1414

1515
The ``dispatcher`` is created and passed to :func:`~softioc.softioc.iocInit`. This is what
16-
allows the use of :mod:`asyncio` functions in this IOC. It contains a new event loop to handle
16+
allows the use of `asyncio` functions in this IOC. It contains a new event loop to handle
1717
this.
1818

1919
The ``async update`` function will increment the value of ``ai`` once per second,
2020
sleeping that coroutine between updates.
2121
Note that we run this coroutine in the ``loop`` of the ``dispatcher``, and not in the
2222
main event loop.
2323

24-
This IOC will, like the one in :doc:`../tutorials/creating-an-ioc`, leave an interactive
24+
This IOC will, like the one in `../tutorials/creating-an-ioc`, leave an interactive
2525
shell open. The values of the PVs can be queried using the methods defined in the
26-
:mod:`softioc.softioc` module.
26+
`softioc.softioc` module.
2727

2828

2929
Asynchronous Channel Access
3030
---------------------------
3131

32-
PVs can be retrieved externally from a PV in an asynchronous manner by using the :py:mod:`aioca` module.
32+
PVs can be retrieved externally from a PV in an asynchronous manner by using the :py`aioca` module.
3333
It provides ``await``-able implementations of ``caget``, ``caput``, etc. See that module for more information.

docs/reference/api.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -374,7 +374,7 @@ starting the IOC.
374374
This must be called exactly once after creating all the records required by
375375
the IOC and before calling :func:`~softioc.softioc.iocInit`. After this
376376
function has been called none of the functions provided by
377-
:mod:`softioc.builder` are usable.
377+
`softioc.builder` are usable.
378378

379379
.. automodule:: softioc.alarm
380380

docs/tutorials/creating-an-ioc.rst

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ Creating an IOC
44
Introduction
55
------------
66

7-
Once the module has been installed (see :doc:`installation`) we can create a
7+
Once the module has been installed (see `installation`) we can create a
88
simple EPICS Input/Output Controller (IOC).
99

10-
An EPICS IOC created with the help of ``pythonIoc`` and :mod:`softioc` is
10+
An EPICS IOC created with the help of ``pythonIoc`` and `softioc` is
1111
referred to as a "Python soft IOC". The code below illustrates a simple IOC
1212
with two Process Variables (PVs):
1313

@@ -19,21 +19,21 @@ Each section is explained in detail below:
1919
:start-after: # Import
2020
:end-before: # Set
2121

22-
The :mod:`softioc` library is part of ``pythonIoc``. The two submodules
23-
:mod:`softioc.softioc` and :mod:`softioc.builder` provide the basic
22+
The `softioc` library is part of ``pythonIoc``. The two submodules
23+
`softioc.softioc` and `softioc.builder` provide the basic
2424
functionality for Python soft IOCs and are the ones that are normally used.
2525

26-
:mod:`cothread` is one of the two possible libraries the IOC can use for
26+
`cothread` is one of the two possible libraries the IOC can use for
2727
asynchronous operations.
28-
(see :doc:`../how-to/use-asyncio-in-an-ioc` for the alternative)
28+
(see `../how-to/use-asyncio-in-an-ioc` for the alternative)
2929

3030

3131

3232
.. literalinclude:: ../examples/example_cothread_ioc.py
3333
:start-after: # Create
3434
:end-before: # Boilerplate
3535

36-
PVs are normally created dynamically using :mod:`softioc.builder`. All PV
36+
PVs are normally created dynamically using `softioc.builder`. All PV
3737
creation must be done before initialising the IOC. We define a lambda function for
3838
`on_update` on ``ao`` such that whenever we set ``ao``, ``ai`` will be set to the
3939
same value. The ``always_update`` flag ensures that the ``on_update`` function is always
@@ -66,11 +66,11 @@ needed. The :func:`~softioc.softioc.interactive_ioc` runs a Python
6666
interpreter shell with a number of useful EPICS functions in scope, and
6767
passing ``globals()`` through can allow interactive interaction with the
6868
internals of the IOC while it's running. The alternative is to call something
69-
like :func:`cothread.WaitForQuit` or some other :mod:`cothread` blocking
69+
like :func:`cothread.WaitForQuit` or some other `cothread` blocking
7070
action.
7171

7272
In this interpreter there is immediate access to methods defined in the
73-
:mod:`softioc.softioc` module. For example the :func:`~softioc.softioc.dbgf` function
73+
`softioc.softioc` module. For example the :func:`~softioc.softioc.dbgf` function
7474
can be run to observe the increasing value of ``AI``::
7575

7676
>>> dbgf("MY-DEVICE-PREFIX:AI")
@@ -93,12 +93,12 @@ and read the value on ``AI`` (exact values will vary based on time taken)::
9393
Creating PVs
9494
------------
9595

96-
See the documentation of :mod:`softioc.builder` for details, but an overview is
96+
See the documentation of `softioc.builder` for details, but an overview is
9797
provided here.
9898

9999
PVs are created internally and dynamically using functionality provided by
100-
:mod:`epicsdbbuilder`, which in this context simply provides mechanisms for
101-
creating ``.db`` files, but :mod:`softioc.builder` also binds each created PV to
100+
`epicsdbbuilder`, which in this context simply provides mechanisms for
101+
creating ``.db`` files, but `softioc.builder` also binds each created PV to
102102
a special ``Python`` device -- this allows PV processing to be hooked into
103103
Python support.
104104

@@ -131,7 +131,3 @@ For all records created by these methods both
131131
reading and writing the current value of the record. For IN records calling
132132
:meth:`~softioc.device.ProcessDeviceSupportIn.set` will trigger a record update
133133
(all IN records are by default created with ``SCAN='I/O Intr'``).
134-
135-
136-
.. _cothread: https://github.com/dls-controls/cothread
137-
.. _epicsdbbuilder: https://github.com/Araneidae/epicsdbbuilder

0 commit comments

Comments
 (0)