From 88cbb783bc6cd11aed890671be0eb4fa02e371e1 Mon Sep 17 00:00:00 2001 From: Archer Bowen Date: Fri, 20 Sep 2024 13:54:13 +0100 Subject: [PATCH] #2840 Fixed sphinx user guide formatting issues. --- docs/source/request_system.rst | 2 ++ .../system/services/terminal.rst | 14 +++++++------- 2 files changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/source/request_system.rst b/docs/source/request_system.rst index f2d2e68d..6b71bf25 100644 --- a/docs/source/request_system.rst +++ b/docs/source/request_system.rst @@ -2,6 +2,8 @@ © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK +.. _request_system: + Request System ************** diff --git a/docs/source/simulation_components/system/services/terminal.rst b/docs/source/simulation_components/system/services/terminal.rst index de6eaf0a..de0bb026 100644 --- a/docs/source/simulation_components/system/services/terminal.rst +++ b/docs/source/simulation_components/system/services/terminal.rst @@ -38,31 +38,31 @@ Implementation - Manages remote connections in a dictionary by session ID. - Processes commands, forwarding to the ``RequestManager`` or ``SessionManager`` where appropriate. - Extends Service class. - - A detailed guide on the implementation and functionality of the Terminal class can be found in the "Terminal-Processing" jupyter notebook. + +A detailed guide on the implementation and functionality of the Terminal class can be found in the "Terminal-Processing" jupyter notebook. Command Format ^^^^^^^^^^^^^^ -``Terminals`` implement their commands through leveraging the pre-existing :doc:`../../request_system`. +Terminals implement their commands through leveraging the pre-existing :ref:`request_system`. -Due to this ``Terminals`` will only accept commands passed within the ``RequestFormat``. +Due to this Terminals will only accept commands passed within the ``RequestFormat``. :py:class:`primaite.game.interface.RequestFormat` For example, ``terminal`` command actions when used in ``yaml`` format are formatted as follows: .. code-block:: yaml + command: - "file_system" - "create" - "file" - "downloads" - "cat.png" - - "False" + - "False -**This command creates file called ``cat.png`` within the ``downloads`` folder.** - -This is then loaded from ``yaml`` into a dictionary containing the terminal command: +This is then loaded from yaml into a dictionary containing the terminal command: .. code-block:: python