Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove broken links #182

Merged
merged 3 commits into from
Aug 30, 2023
Merged

Remove broken links #182

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
16ae649
Remove adapters from api
abbiemery Aug 30, 2023
ad5e731
Remove links to adapter api
abbiemery Aug 30, 2023
ba8721f
Add missed iobox device in api ref
abbiemery Aug 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/user/explanations/adapters.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ There are four adapter types included in the framework:
Command adapter
----------------
The command adapter identifies and handles commands from incoming messages and is
utilised with `TcpIo`. Commands are defined via decoration of adapter methods and the
only such command type currently is a `RegexCommand`. This matches incoming messages to
utilised with ``TcpIo``. Commands are defined via decoration of adapter methods and the
only such command type currently is a ``RegexCommand``. This matches incoming messages to
regex patterns and processes the command appropriately.


Expand All @@ -38,7 +38,7 @@ An adapter for use on a ZeroMQ data stream.

HTTP adapter
------------
An adapter that utilises HTTP endpoints for the `HttpIo`.
An adapter that utilises HTTP endpoints for the ``HttpIo``.


EPICS adapter
Expand Down
4 changes: 2 additions & 2 deletions docs/user/explanations/system-simulation-adapters.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ for implementing this.
Nested Amplifier Example
------------------------

The following system adapter is a simple `CommandAdapter`. This Can be used to query the
The following system adapter is a simple ``CommandAdapter``. This Can be used to query the
SystemSimulationComponent for a list of ID's of the components it contains; and to
return the wiring map of the components.

Expand All @@ -51,7 +51,7 @@ return the wiring map of the components.
"""Returns the wiring object used by the nested scheduler."""
return str(self._wiring).encode("utf-8")

To use this adapter we would need to put it in an adapter container with TcpIo and
To use this adapter we would need to put it in an adapter container with ``TcpIo`` and
assign it as an argument in the SystemSimulationComponent.

.. code-block:: python
Expand Down
90 changes: 5 additions & 85 deletions docs/user/reference/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,97 +136,17 @@ This is the internal API reference for tickit
------------------------------------------------


.. automodule:: tickit.adapters

``tickit.adapters``
-------------------

.. automodule:: tickit.adapters.io

``tickit.adapters.io``
----------------------

.. automodule:: tickit.adapters.io.tcp_io
:members:

``tickit.adapters.io.tcp_io``
-----------------------------

.. automodule:: tickit.adapters.io.http_io
:members:

``tickit.adapters.io.http_io``
------------------------------

.. automodule:: tickit.adapters.io.epics_io
:members:

``tickit.adapters.io.epics_io``
-------------------------------

.. automodule:: tickit.adapters.io.zeromq_push_io
:members:

``tickit.adapters.io.zeromq_push_io``
-------------------------------------


.. automodule:: tickit.adapters.specifications

``tickit.adapters.specifications``
----------------------------------

.. automodule:: tickit.adapters.specifications.http_endpoint
:members:

``tickit.adapters.specifications.http_endpoint``
------------------------------------------------

.. automodule:: tickit.adapters.specifications.regex_command
:members:

``tickit.adapters.specifications.regex_command``
------------------------------------------------
.. automodule:: tickit.devices

``tickit.devices``
------------------

.. automodule:: tickit.adapters.epics
.. automodule:: tickit.devices.iobox
:members:

``tickit.adapters.epics``
-------------------------

.. automodule:: tickit.adapters.http
:members:

``tickit.adapters.http``
``tickit.devices.iobox``
------------------------


.. automodule:: tickit.adapters.tcp
:members:

``tickit.adapters.tcp``
-----------------------

.. automodule:: tickit.adapters.zmq
:members:

``tickit.adapters.zmq``
-----------------------

.. automodule:: tickit.adapters.system
:members:

``tickit.adapters.system``
--------------------------



.. automodule:: tickit.devices

``tickit.devices``
------------------

.. automodule:: tickit.devices.sink
:members:

Expand Down
8 changes: 4 additions & 4 deletions docs/user/tutorials/use-command-adapter.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Using an Adapter
This tutorial shows how to use a simple adapter to externally interact with a
device in the tickit framework.

We will use a `CommandAdapter` which will act as a simple TCP interface to the
We will use a ``CommandAdapter`` which will act as a simple TCP interface to the
``Amplifier`` device we created in the previous how-to.

.. seealso::
Expand All @@ -17,7 +17,7 @@ Initialise Adapter
------------------

We shall begin using the same ``amplifier.py`` file from the ``Amplifier`` device. In
that file add a new ``AmplifierAdapter`` class which inherits `CommandAdapter`.
that file add a new ``AmplifierAdapter`` class which inherits ``CommandAdapter``.


.. code-block:: python
Expand All @@ -44,7 +44,7 @@ We shall create two methods, one which returns the current amplification of the
device, and another which sets a new value for the amplification.

We shall begin by creating a method which returns the current value of the
amplification. To do this we register it as a `RegexCommand` which is called by
amplification. To do this we register it as a ``RegexCommand`` which is called by
sending ``A?``. Since reading a device value will not alter the device state we
shall set ``interrupt`` to ``False``. We shall also specify that the byte encoded
message should be decoded to a string prior to matching using the ``utf-8`` standard.
Expand Down Expand Up @@ -109,7 +109,7 @@ Include the Adapter

In order to now use this adapter to control our device we need to include it in
our amplifier `ComponentConfig`. To do this we first construct an `AdapterContainer`
with our ``AmplifierAdapter`` and the appropriate `AdapterIo`. In this case `TcpIo`.
with our ``AmplifierAdapter`` and the appropriate `AdapterIo`. In this case ``TcpIo``.
Once this is done we simply add it to the arguments of `DeviceSimulation`.

.. code-block:: python
Expand Down