Remove broken links (#182)

As described in #181 , the docs build has broken with the latest release of setuptools. As this is only a docs break, and is creating a blocker for more urgent work I suggest we remove them for now to allow CI to pass, then dedicate the time to fix it correctly after the changed for Zebra are implemented.
DiamondLightSource · Aug 30, 2023 · 04a0c47 · 04a0c47
1 parent 52325c7
commit 04a0c47
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 94 deletions.
diff --git a/docs/user/explanations/adapters.rst b/docs/user/explanations/adapters.rst
@@ -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.
 
 
@@ -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

diff --git a/docs/user/explanations/system-simulation-adapters.rst b/docs/user/explanations/system-simulation-adapters.rst
@@ -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.
 
@@ -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

diff --git a/docs/user/reference/api.rst b/docs/user/reference/api.rst
@@ -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:
 

diff --git a/docs/user/tutorials/use-command-adapter.rst b/docs/user/tutorials/use-command-adapter.rst
@@ -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::
@@ -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
@@ -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.
@@ -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