#2840 Fixed sphinx user guide formatting issues.

This commit is contained in:
Archer Bowen
2024-09-20 13:54:13 +01:00
parent 710a4d0e55
commit 88cbb783bc
2 changed files with 9 additions and 7 deletions

View File

@@ -2,6 +2,8 @@
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
.. _request_system:
Request System
**************

View File

@@ -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