#2682 Backport changes to core PrimAITE

docs/Makefile

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 # Minimal makefile for Sphinx documentation
 # You can set these variables from the command line, and also
 # from the environment for the first two.

docs/build-sphinx-docs-to-github-pages.sh

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 #!/bin/bash
 set -x
 
@@ -42,7 +43,7 @@ touch .nojekyll
 # Add README
 cat > README.md <<EOF
 # README for the Sphinx Docs GitHub Pages Branch
-This branch is simply a cache for the website served from https://Autonomous-Resilient-Cyber-Defence.github.io/PrimAITE/,
+This branch is simply a cache for the website served from https://{todo:fill in URL}.github.io/PrimAITE/,
 and is  not intended to be viewed on github.com.
 For more information on how this site is built using Sphinx, Read the Docs, GitHub Actions/Pages, and demo
 implementation from https://github.com/annegentle, see:

docs/conf.py

@@ -147,7 +147,7 @@ def copy_notebooks_to_docs() -> Any:
     This allows developers to create new notebooks without having to worry about updating documentation when
     a new notebook is included within PrimAITE.
     """
-    notebook_asset_types = [".ipynb", ".png"]
+    notebook_asset_types = [".ipynb", ".png", ".svg"]
     notebook_directories = []
 
     # find paths where notebooks are contained

docs/make.bat

@@ -1,4 +1,5 @@
 @ECHO OFF
+REM  © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 
 setlocal EnableDelayedExpansion
 

docs/source/example_notebooks.rst

@@ -77,6 +77,6 @@ The following extensions should now be installed
     :width: 300
     :align: center
 
-VSCode will then ask for a Python environment version to use. PrimAITE is compatible with Python versions 3.8 - 3.11
+VSCode will then ask for a Python environment version to use. PrimAITE is compatible with Python versions 3.9 - 3.11
 
 You should now be able to interact with the notebook.

docs/source/game_layer.rst

@@ -85,7 +85,6 @@ blue_agent:
           weight: 1.0
           options:
             agent_name: client_2_green_user
-
 ```
 
 When defining agent reward sharing, users must be careful to avoid circular references, as that would lead to an infinite calculation loop. PrimAITE will prevent circular dependencies and provide a helpful error message if they are detected in the yaml.

docs/source/getting_started.rst

@@ -113,7 +113,7 @@ For example:
 
 .. code-block:: bash
 
-    git clone https://github.com/Autonomous-Resilient-Cyber-Defence/PrimAITE
+    git clone https://github.com/{todo:fill in URL}/PrimAITE
     cd primaite
 
 2. Create and activate your Python virtual environment (venv)