diff --git a/docs/conf.py b/docs/conf.py index 70754138..eb4132d1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -68,6 +68,18 @@ html_static_path = ["_static"] html_theme_options = {"globaltoc_collapse": True, "globaltoc_maxdepth": 2} html_copy_source = False nbsphinx_allow_errors = False # set to True to take shortcuts +html_scaled_image_link = False + +# make some stuff easier to read +nbsphinx_prolog = """ +.. raw:: html + + +""" def replace_token(app: Any, docname: Any, source: Any): diff --git a/docs/source/example_notebooks.rst b/docs/source/example_notebooks.rst index 4499a00c..f207c601 100644 --- a/docs/source/example_notebooks.rst +++ b/docs/source/example_notebooks.rst @@ -12,7 +12,7 @@ There are a few example notebooks included which help with the understanding of The PrimAITE documentation includes a pre executed example of notebooks. See :ref:`Executed Notebooks`. -The Jupyter notebooks can also be run interactively via the 2 examples below. These assume that the instructions to install PrimAITE from the :ref:`Getting Started ` page is completed as a prerequisite. +In order to run the notebooks interactively, :ref:`install PrimAITE ` and follow these steps: Running Jupyter Notebooks ------------------------- diff --git a/src/primaite/notebooks/Data-Manipulation-E2E-Demonstration.ipynb b/src/primaite/notebooks/Data-Manipulation-E2E-Demonstration.ipynb index f09f9ea7..8104149e 100644 --- a/src/primaite/notebooks/Data-Manipulation-E2E-Demonstration.ipynb +++ b/src/primaite/notebooks/Data-Manipulation-E2E-Demonstration.ipynb @@ -15,7 +15,7 @@ "\n", "The network consists of an office subnet and a server subnet. Clients in the office access a website which fetches data from a database. Occasionally, admins need to access the database directly from the clients.\n", "\n", - "[](_package_data/uc2_network.png)\n", + "![UC2 Network](./_package_data/uc2_network.png)\n", "\n", "_(click image to enlarge)_\n", "\n",