From 5db8bd7c4c89ecf937d586d019cc2b2fe738d188 Mon Sep 17 00:00:00 2001
From: Marek Wolan <marek.wolan@methods.co.uk>
Date: Tue, 4 Jul 2023 11:34:36 +0100
Subject: [PATCH] Resolve remaining build warnings for docs

---
 docs/api.rst                             | 16 ----------------
 docs/index.rst                           |  1 +
 src/primaite/environment/observations.py |  8 ++++++--
 3 files changed, 7 insertions(+), 18 deletions(-)
 delete mode 100644 docs/api.rst

diff --git a/docs/api.rst b/docs/api.rst
deleted file mode 100644
index df2bc193..00000000
--- a/docs/api.rst
+++ /dev/null
@@ -1,16 +0,0 @@
-..
-   DO NOT DELETE THIS FILE! It contains the all-important `.. autosummary::` directive with `:recursive:` option, without
-   which API documentation wouldn't get extracted from docstrings by the `sphinx.ext.autosummary` engine. It is hidden
-   (not declared in any toctree) to remove an unnecessary intermediate page; index.rst instead points directly to the
-   package page. DO NOT REMOVE THIS FILE!
-
-    Credit to https://github.com/JamesALeedham/Sphinx-Autosummary-Recursion for the custom templates.
-..
-
-.. autosummary::
-   :toctree: source/_autosummary
-   :template: custom-module-template.rst
-   :recursive:
-
-   primaite
-   tests
diff --git a/docs/index.rst b/docs/index.rst
index 17dae2c9..72e91b07 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -43,6 +43,7 @@ The best place to start is :ref:`about`
    :caption: Project Links:
    :hidden:
 
+..
    #Code <>
    #Issues <>
    #Pull Requests <>
diff --git a/src/primaite/environment/observations.py b/src/primaite/environment/observations.py
index e347a65c..4d027326 100644
--- a/src/primaite/environment/observations.py
+++ b/src/primaite/environment/observations.py
@@ -49,6 +49,7 @@ class NodeLinkTable(AbstractObservationComponent):
     This will create the observation space formatted as a table of integers.
     There is one row per node, followed by one row per link.
     The number of columns is 4 plus one per service. They are:
+
         * node/link ID
         * node hardware status / 0 for links
         * node operating system status (if active/service) / 0 for links
@@ -175,6 +176,7 @@ class NodeStatuses(AbstractObservationComponent):
     integers.
     Each node has 3 elements plus 1 per service. It will have the following structure:
     .. code-block::
+
         [
             node1 hardware state,
             node1 OS state,
@@ -275,6 +277,7 @@ class LinkTrafficLevels(AbstractObservationComponent):
 
     For each link, total traffic or traffic per service is encoded into a categorical value.
     For example, if ``quantisation_levels=5``, the traffic levels represent these values:
+
         * 0 = No traffic (0% of bandwidth)
         * 1 = No traffic (0%-33% of bandwidth)
         * 2 = No traffic (33%-66% of bandwidth)
@@ -426,7 +429,7 @@ class ObservationsHandler:
         """Remove a component from this handler.
 
         :param obs_component: Which component to remove. It must exist within this object's
-        ``registered_obs_components`` attribute.
+            ``registered_obs_components`` attribute.
         :type obs_component: AbstractObservationComponent
         """
         self.registered_obs_components.remove(obs_component)
@@ -470,7 +473,8 @@ class ObservationsHandler:
 
         The expected format for the config dictionary is:
 
-        ..code-block::python
+        .. code-block:: python
+
             config = {
                 components: [
                     {