Move examples into basic dir and add index files

This corrects how the examples look with other themes
qutech · Aug 13, 2024 · 31ac3ff · 31ac3ff
1 parent bfaad95
commit 31ac3ff
Show file tree

Hide file tree

Showing 14 changed files with 93 additions and 82 deletions.
diff --git a/docs/examples/DataSet/Working with snapshots.ipynb b/docs/examples/DataSet/Working with snapshots.ipynb
@@ -277,7 +277,7 @@
     "\n",
     "Experimental setups are large, and instruments tend to be quite complex in that they comprise many parameters and other stateful parts. It would be very time-consuming for the user to manually go through every instrument and parameter, and collect the snapshot data.\n",
     "\n",
-    "Here is where the concept of station comes into play. Instruments, parameters, and other submodules can be added to a [Station object](../Station.ipynb) ([nbviewer.jupyter.org link](https://nbviewer.jupyter.org/github/QCoDeS/Qcodes/tree/main/docs/examples/Station.ipynb)). In turn, the station has its `snapshot` method that allows to create a collective, single snapshot of all the instruments, parameters, and submodules.\n",
+    "Here is where the concept of station comes into play. Instruments, parameters, and other submodules can be added to a [Station object](../basic_examples/Station.ipynb) ([nbviewer.jupyter.org link](https://nbviewer.jupyter.org/github/microsoft/Qcodes/tree/main/docs/examples/basic_examples/Station.ipynb)). In turn, the station has its `snapshot` method that allows to create a collective, single snapshot of all the instruments, parameters, and submodules.\n",
     "\n",
     "Note that in this article the focus is on the snapshot feature of the QCoDeS `Station`, while it has some other features (also some legacy once)."
    ]

diff --git a/docs/examples/DataSet/index.rst b/docs/examples/DataSet/index.rst
@@ -0,0 +1,9 @@
+DataSet
+-------
+
+.. toctree::
+    :glob:
+
+    *
+    Real_instruments/*
+    Cache/*
diff --git a/docs/examples/Parameters/index.rst b/docs/examples/Parameters/index.rst
@@ -0,0 +1,9 @@
+Parameters
+----------
+
+.. include:: readme.txt
+
+.. toctree::
+    :glob:
+
+    *
diff --git a/docs/examples/15_minutes_to_QCoDeS.ipynb → ...basic_examples/15_minutes_to_QCoDeS.ipynb b/docs/examples/15_minutes_to_QCoDeS.ipynb → ...basic_examples/15_minutes_to_QCoDeS.ipynb
diff --git a/docs/examples/Configuring_QCoDeS.ipynb → ...s/basic_examples/Configuring_QCoDeS.ipynb b/docs/examples/Configuring_QCoDeS.ipynb → ...s/basic_examples/Configuring_QCoDeS.ipynb
@@ -204,7 +204,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "The default configuration is explained in more detail in the [api docs](../api/configuration/index.rst#qcodes-default-configuration)"
+    "The default configuration is explained in more detail in the [api docs](../../api/configuration/index.rst#qcodes-default-configuration)"
    ]
   },
   {

diff --git a/docs/examples/Station.ipynb → docs/examples/basic_examples/Station.ipynb b/docs/examples/Station.ipynb → docs/examples/basic_examples/Station.ipynb
@@ -293,7 +293,7 @@
     "\n",
     "For example, the `Measurement` object accepts a station argument exactly for the purpose of storing a snapshot of the whole experimental setup next to the measured data.\n",
     "\n",
-    "Read more about snapshots in general, how to work with them, station's snapshot in particular, and more -- in [this notebook](DataSet/Working with snapshots.ipynb)."
+    "Read more about snapshots in general, how to work with them, station's snapshot in particular, and more -- in [this notebook](../DataSet/Working with snapshots.ipynb)."
    ]
   },
   {
@@ -600,7 +600,7 @@
     "VSCode can be conveniently used to work with station files. The [YAML extension by Red Hat](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml), allows to use JSON schemas to validate and auto-complete YAML files.\n",
     "\n",
     "\n",
-    "![vscode](assets/vscode_integration.gif \"Auto-validation and -completion in VSCode\")\n",
+    "![vscode](../assets/vscode_integration.gif \"Auto-validation and -completion in VSCode\")\n",
     "\n",
     "\n",
     "**Quick setup steps**\n",

diff --git a/docs/examples/basic_examples/index.rst b/docs/examples/basic_examples/index.rst
@@ -0,0 +1,7 @@
+Basic examples
+--------------
+
+.. toctree::
+    :glob:
+
+    *
diff --git a/docs/examples/driver_examples/Qcodes example with Agilent 34400A.ipynb b/docs/examples/driver_examples/Qcodes example with Agilent 34400A.ipynb
@@ -116,7 +116,7 @@
    "id": "charming-chorus",
    "metadata": {},
    "source": [
-    "Above initialized instruments can be registered as components to your station by following instructions as mentioned in [15 min of QCoDeS Notebook](../15_minutes_to_QCoDeS.ipynb)"
+    "Above initialized instruments can be registered as components to your station by following instructions as mentioned in [15 min of QCoDeS Notebook](../basic_examples/15_minutes_to_QCoDeS.ipynb)"
    ]
   },
   {

diff --git a/docs/examples/driver_examples/index.rst b/docs/examples/driver_examples/index.rst
@@ -0,0 +1,8 @@
+Drivers
+-------
+
+.. toctree::
+    :maxdepth: 1
+    :glob:
+
+    *
diff --git a/docs/examples/index.rst b/docs/examples/index.rst
@@ -5,61 +5,16 @@ These are all examples based on notebooks that can be found in
 https://github.com/QCoDeS/Qcodes/tree/main/docs/examples and below. To experiment with the
 examples you can download them directly from the git repository.
 
-Basic examples
---------------
 
 .. toctree::
-    :glob:
-
-    *
-
-
-Parameters
----------------
-
-.. include:: Parameters/readme.txt
-
-.. toctree::
-    :glob:
-
-    Parameters/*
-
-DataSet
--------
-
-.. toctree::
-    :glob:
-
-    DataSet/*
-    DataSet/Real_instruments/*
-    DataSet/Cache/*
-
-Plotting
---------
-
-.. toctree::
-    :glob:
-
-    plotting/*
-
-Drivers
--------
-
-.. toctree::
-    :maxdepth: 1
-    :glob:
-
-    driver_examples/*
-
-Writing Drivers
----------------
-
-.. include:: writing_drivers/readme.txt
-
-.. toctree::
-    :glob:
+    basic_examples/index
+    Parameters/index
+    DataSet/index
+    plotting/index
+    driver_examples/index
+    writing_drivers/index
+    logging/index
 
-    writing_drivers/*
 
 Logging
 --------

diff --git a/docs/examples/logging/index.rst b/docs/examples/logging/index.rst
@@ -0,0 +1,7 @@
+Logging
+--------
+
+.. toctree::
+    :glob:
+
+    *
diff --git a/docs/examples/plotting/index.rst b/docs/examples/plotting/index.rst
@@ -0,0 +1,7 @@
+Plotting
+--------
+
+.. toctree::
+    :glob:
+
+    *
diff --git a/docs/examples/writing_drivers/index.rst b/docs/examples/writing_drivers/index.rst
@@ -0,0 +1,9 @@
+Writing Drivers
+---------------
+
+.. include:: readme.txt
+
+.. toctree::
+    :glob:
+
+    *
diff --git a/docs/index.rst b/docs/index.rst
@@ -25,7 +25,7 @@ The goal is a common framework for physics experiments, so:
   a new experiment is streamlined
 - physics experiments can take advantage of modern software and best practices
 
-Read `15 minutes to QcoDeS <examples/15_minutes_to_QCoDeS.ipynb>`_ to have quick overview on QCoDeS.
+Read `15 minutes to QcoDeS <examples/basic_examples/15_minutes_to_QCoDeS.ipynb>`_ to have quick overview on QCoDeS.
 Many more elaborate examples can be found in the `example notebooks <examples/index.rst>`__.
 
 
@@ -37,7 +37,7 @@ Documentation
    :maxdepth: 2
 
    start/index
-   examples/15_minutes_to_QCoDeS
+   examples/basic_examples/15_minutes_to_QCoDeS
    examples/index
    community/index
    dataset/index