top-sim · myxie · Aug 10, 2025 · Jul 7, 2025 · Aug 8, 2025 · Aug 10, 2025
diff --git a/.readthedocs.yml → .readthedocs.yaml b/.readthedocs.yml → .readthedocs.yaml
@@ -1,6 +1,12 @@
 version: 2
 
 # Build documentation in the docs/ directory with Sphinx
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+
 sphinx:
    configuration: docs/source/conf.py
 
@@ -10,7 +16,6 @@ formats:
 
 # Optionally set the version of Python and requirements required to build your docs
 python:
-   version: 3.7
    install:
    - requirements: docs/requirements.txt
    - requirements: requirements.txt
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1 +1 @@
-sphinx_book_theme >=0.0.30
+sphinx_rtd_theme
diff --git a/docs/source/_static/css/custom.css b/docs/source/_static/css/custom.css
@@ -0,0 +1,30 @@
+@import "theme.css";
+
+.wy-side-nav-search {
+    background: #BEBEBE;
+}
+.wy-nav-side {
+    background: #F5F5F5;
+}
+
+.wy-menu-vertical p.caption{
+    color: #BEBEBE;
+}
+.wy-menu-vertical a{
+    color: black;
+}
+
+.wy-menu-vertical a:hover {
+    background-color: #BEBEBE;
+    color: black;
+}
+
+.wy-table-responsive table td,
+.wy-table-responsive table th {
+    white-space: normal !important; /* Allow text to wrap */
+    word-wrap: break-word !important;
+}
+
+.wy-nav-content {
+    max-width: 1000px
+}
diff --git a/docs/source/_static/custom.css b/docs/source/_static/custom.css
diff --git a/docs/source/algorithms/index.rst b/docs/source/algorithms/index.rst
@@ -20,6 +20,5 @@ a defining feature of the simulation framework.
 
 TopSim separates allocation policies into two categories:
 
-* Reservation-based allocation, such as SLURM or typical batch-processing models
-* Free allocation, which is the model that popular heuristics such as HEFT
-are built upon.
+    * Reservation-based allocation, such as SLURM or typical batch-processing models
+    * Free allocation, which is the model that popular heuristics such as HEFT are built upon.
diff --git a/docs/source/algorithms/scheduling.rst b/docs/source/algorithms/scheduling.rst
@@ -4,4 +4,4 @@ Scheduling
 
 .. currentmodule:: topsim.algorithms
 
-Use the :py:class:`~scheduling.Algorithm` ABC as a starting point.
+Use the :py:class:`~scheduling.Scheduling` ABC as a starting point.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -20,7 +20,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'TopSim'
-copyright = '2019-2021, RW Bunney'
+copyright = '2019-2025, RW Bunney'
 author = 'RW Bunney'
 
 master_doc = 'index'
@@ -31,7 +31,7 @@
 # ones.
 extensions = [
     'sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'sphinx.ext.autosummary',
-    'sphinx.ext.viewcode'
+    'sphinx.ext.viewcode', 'sphinx_rtd_theme'
 ]
 
 # Add any paths that contain templates here, relative to this sdirectory.
@@ -50,18 +50,19 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'pydata_sphinx_theme'
-
+# html_theme = 'pydata_sphinx_theme'
+html_theme = 'sphinx_rtd_theme'
 # html_theme_options = {"full_logo":"true"}
-html_theme_options = {
-    # "show_toc_level": True,
-    # "collapse_navigation": False,
-    # "navigation_depth": 2
-}
+# html_theme_options = {
+#     # "show_toc_level": True,
+#     # "collapse_navigation": False,
+#     # "navigation_depth": 2
+# }
 html_logo = 'new_logo.svg'
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
-
-html_title = 'TopSim'
+html_css_files = ["css/custom.css"]
+html_style = "css/custom.css"
+html_theme_options = {"logo_only": True}
diff --git a/docs/source/configuration/index.rst b/docs/source/configuration/index.rst
@@ -16,7 +16,7 @@ What needs configuring?
 
 The following actors require configuration, which is parsed by the :py:class:`~config.Config` module when a simulation is initiated.
 
-We use the configuration that supported the :ref:`model-overview <model-overview>` discussion in :ref:`getting-started <getting-started>`.
+We use the configuration that supported the :ref:`model_overview` discussion in :ref:`getting_started`.
 
 * Instrument (which also includes the observation plan)
 * Cluster

diff --git a/docs/source/getting_started/index.rst b/docs/source/getting_started/index.rst
@@ -1,4 +1,4 @@
-.. _getting-started:
+.. _getting_started:
 
 -------------------------
 Getting Started

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -9,6 +9,7 @@ operations, such as the Square Kilometre Array (SKA).
 
 Overview
 ---------
+
 TopSim follows a discrete event simulation model, using the
 `SimPy <https://simpy.readthedocs.io/en/latest/>`_ module as
 the foundation for the simulations. 
@@ -33,6 +34,7 @@ sections.
 
 Installation
 -------------
+
 .. toctree::
     :maxdepth: 3
 

diff --git a/docs/source/reference/api/core/topsim.core.buffer.Buffer.rst b/docs/source/reference/api/core/topsim.core.buffer.Buffer.rst
diff --git a/docs/source/reference/api/core/topsim.core.buffer.ColdBuffer.rst b/docs/source/reference/api/core/topsim.core.buffer.ColdBuffer.rst
diff --git a/docs/source/reference/api/core/topsim.core.buffer.HotBuffer.rst b/docs/source/reference/api/core/topsim.core.buffer.HotBuffer.rst
diff --git a/docs/source/reference/api/core/topsim.core.cluster.Cluster.rst b/docs/source/reference/api/core/topsim.core.cluster.Cluster.rst
diff --git a/docs/source/reference/api/core/topsim.core.config.Config.rst b/docs/source/reference/api/core/topsim.core.config.Config.rst
diff --git a/docs/source/reference/api/core/topsim.core.delay.DelayModel.rst b/docs/source/reference/api/core/topsim.core.delay.DelayModel.rst
diff --git a/docs/source/reference/api/core/topsim.core.monitor.Monitor.rst b/docs/source/reference/api/core/topsim.core.monitor.Monitor.rst
Original file line number	Diff line number	Diff line change
Expand Up		@@ -4,4 +4,4 @@ Scheduling

		.. currentmodule:: topsim.algorithms

		Use the :py:class:`~scheduling.Algorithm` ABC as a starting point.
		Use the :py:class:`~scheduling.Scheduling` ABC as a starting point.