oxbrbtx/PrimAITE
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

#2472: integrating jupyter notebooks into documentation

Browse Source
This commit is contained in:
Czar Echavez
2024-05-09 13:43:55 +01:00
parent d02b7744ae
commit 81c523dc67
8 changed files with 94 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/source/configuration/simulation.rst
View File

@@ -75,7 +75,7 @@ this results in:
The human readable name for the link. Not used in code, however is useful for a human to understand what the link is for.
``endpoint_a_hostname``
^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^
The ``hostname`` of the node which must be connected.
@@ -86,7 +86,7 @@ The port on ``endpoint_a_hostname`` which is to be connected to ``endpoint_b_por
This accepts an integer value e.g. if port 1 is to be connected, the configuration should be ``endpoint_a_port: 1``
``endpoint_b_hostname``
^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^
The ``hostname`` of the node which must be connected.

7
docs/source/example_notebooks.rst
View File

@@ -5,9 +5,14 @@
Example Jupyter Notebooks
=========================
Executed Notebooks
------------------
There are a few example notebooks included which help with the understanding of PrimAITE's capabilities.
The Jupyter Notebooks can be run via the 2 examples below. These assume that the instructions to install PrimAITE from the :ref:`Getting Started <getting-started>` page is completed as a prerequisite.
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 <getting-started>` page is completed as a prerequisite.
Running Jupyter Notebooks
-------------------------

13
docs/source/executed_notebooks.rst Normal file
View File

@@ -0,0 +1,13 @@
.. only:: comment
© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
.. _Executed Notebooks:
Executed Jupyter Notebooks
==========================
Below is a list of available pre-executed notebooks.
.. raw:: html
{NOTEBOOK_LINKS}