#2472: apply PR suggestions + minor fixes to make the notebooks output beautifuller
This commit is contained in:
12
docs/conf.py
12
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
|
||||
|
||||
<style>
|
||||
.stderr {
|
||||
color: #000 !important
|
||||
}
|
||||
</style>
|
||||
"""
|
||||
|
||||
|
||||
def replace_token(app: Any, docname: Any, source: Any):
|
||||
|
||||
@@ -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 <getting-started>` page is completed as a prerequisite.
|
||||
In order to run the notebooks interactively, :ref:`install PrimAITE <getting-started>` and follow these steps:
|
||||
|
||||
Running Jupyter Notebooks
|
||||
-------------------------
|
||||
|
||||
@@ -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",
|
||||
"[<img src=\"_package_data/uc2_network.png\" width=\"500\"/>](_package_data/uc2_network.png)\n",
|
||||
"\n",
|
||||
"\n",
|
||||
"_(click image to enlarge)_\n",
|
||||
"\n",
|
||||
|
||||
Reference in New Issue
Block a user