From 94ed4c01241a6f4c3eaab8270ccfa7aada523d92 Mon Sep 17 00:00:00 2001
From: Bjoern Ludwig <bjoern.ludwig@ptb.de>
Date: Sat, 21 Jan 2023 02:38:39 +0100
Subject: [PATCH] docs(examples): improve and correct examples section
---
docs/examples.rst | 17 ++++++-----------
1 file changed, 6 insertions(+), 11 deletions(-)
diff --git a/docs/examples.rst b/docs/examples.rst
index 41b3789..5316921 100644
--- a/docs/examples.rst
+++ b/docs/examples.rst
@@ -1,20 +1,15 @@
Examples
========
-Proof-of-Concept examples
--------------------------
-
For certain proof of concepts, we provide Jupyter notebooks, which require
-additional dependencies to be installed. This can be achieved by appending
-:code:`[examples]` to the install command, e.g.
-
-.. code-block:: shell
-
- pip install .[examples]
-
-Afterwards you can browser through the following list:
+additional dependencies to be installed. This is described in our
+`INSTALL guide <https://zema-emc-annotated.readthedocs.io/en/latest/INSTALL.html#optional-jupyter-notebook-dependencies>`_
+After executing the necessary command, you can browser through the following list but
+more importantly, check out the core class
+`ZeMASamples <https://zema-emc-annotated.readthedocs.io/en/latest/zema_emc_annotated.dataset.html#zema_emc_annotated.dataset.ZeMASamples to get the samples in>`_.
.. toctree::
:maxdepth: 1
+ :caption: Jupyter Notebook with code to access the dataset:
examples/read_dataset
--
GitLab