Fixed incorrect formatting on .rst and new priv esc notebook

docs/source/rewards.rst

@@ -11,9 +11,10 @@ Components
 **********
 The following API pages describe the use of each reward component and the possible configuration options. An example of configuring each via yaml is also provided.
 
-:py:class:`DummyReward`
+:py:class:`primaite.game.agent.rewards.DummyReward`
 
 .. code-block:: yaml
+
     agents:
       - ref: agent_name
         # ...
@@ -26,6 +27,7 @@ The following API pages describe the use of each reward component and the possib
 :py:class:`primaite.game.agent.rewards.DatabaseFileIntegrity`
 
 .. code-block:: yaml
+
     agents:
       - ref: agent_name
         # ...
@@ -39,9 +41,10 @@ The following API pages describe the use of each reward component and the possib
                 file_name: database.db
 
 
-:py:class:`WebServer404Penalty`
+:py:class:`primaite.game.agent.rewards.WebServer404Penalty`
 
 .. code-block:: yaml
+
     agents:
       - ref: agent_name
         # ...
@@ -55,9 +58,10 @@ The following API pages describe the use of each reward component and the possib
                 sticky: false
 
 
-:py:class:`WebpageUnavailablePenalty`
+:py:class:`primaite.game.agent.rewards.WebpageUnavailablePenalty`
 
 .. code-block:: yaml
+
     agents:
       - ref: agent_name
         # ...
@@ -70,9 +74,10 @@ The following API pages describe the use of each reward component and the possib
                 sticky: false
 
 
-:py:class:`GreenAdminDatabaseUnreachablePenalty`
+:py:class:`primaite.game.agent.rewards.GreenAdminDatabaseUnreachablePenalty`
 
 .. code-block:: yaml
+
     agents:
       - ref: agent_name
         # ...
@@ -85,9 +90,10 @@ The following API pages describe the use of each reward component and the possib
                 sticky: false
 
 
-:py:class:`SharedReward`
+:py:class:`primaite.game.agent.rewards.SharedReward`
 
 .. code-block:: yaml
+
     agents:
       - ref: scripted_agent
         # ...
@@ -101,9 +107,10 @@ The following API pages describe the use of each reward component and the possib
                 agent_name: scripted_agent
 
 
-:py:class:`ActionPenalty`
+:py:class:`primaite.game.agent.rewards.ActionPenalty`
 
 .. code-block:: yaml
+
     agents:
       - ref: agent_name
         # ...

src/primaite/notebooks/Privilege-Escalation-and Data-Loss-Example.ipynb

@@ -1,18 +1,13 @@
 {
  "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK"
-   ]
-  },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
     "# Simulating Privilege Escalation and Data Loss Using SSH and ACLs Manipulation\n",
     "\n",
+    "© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK\n",
+    "\n",
     "## Overview\n",
     "\n",
     "This Jupyter notebook demonstrates a cyber scenario focusing on internal privilege escalation and data loss through the manipulation of SSH access and Access Control Lists (ACLs). The scenario is designed to model and visualise how a disgruntled junior engineer might exploit internal network vulnerabilities and social engineering of account credentials to escalate privileges and cause significant data loss and disruption to services.\n",
@@ -53,7 +48,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# The Scenario"
+    "## The Scenario"
    ]
   },
   {
@@ -558,7 +553,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# End of Scenario Summary\n",
+    "## End of Scenario Summary\n",
     "\n",
     "In this simulation, we modelled a cyber attack scenario where a disgruntled junior engineer exploits internal network vulnerabilities to escalate privileges, causing significant data loss and disruption of services. The following key actions were performed:\n",
     "\n",
@@ -604,7 +599,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.9"
+   "version": "3.10.12"
   }
  },
  "nbformat": 4,