Merge pull request #213 from sandialabs/docs

Docs

Author: rsbrost

docs/source/advanced_usage.rst

@@ -5,4 +5,12 @@ Advanced Usage
    :maxdepth: 2
 
    advanced/writing_a_driver
-   advanced/nested_experiments
+   advanced/nested_experiments
+
+Demo Notebooks
+==============
+
+.. toctree::
+   :maxdepth: 2
+
+   advanced/advanced_notebooks

docs/source/api_index.rst

@@ -2,7 +2,7 @@ API
 ===
 
 .. toctree::
-	:maxdepth: 3
+	:maxdepth: 4
 
 	api/general
 	api/measurement

docs/source/basics/installation.md

@@ -20,9 +20,11 @@ git clone https://github.com/sandialabs/pyscan
 3. Install pyscan with
 
 ```
-pip install .
+pip install -e .
 ```
 
+The `-e` makes the package editable, so that if you make modifications to your drivers, for example, you don't need to reinstall the package. This is the recommended method of installation since pyscan is largely intended to be modified when you add drivers for new instruments.
+
 ## Additional Requirements
 
 Some instruments require extra installations in order to use them. For example, Ocean Optics (now known as Ocean Insight) spectrometers require the python package `seabreeze`.  Thorlabs drivers may also require the installation of proprietary .dll files available on their website by installing Thorlabs Kinesis.

docs/source/conf.py

@@ -83,6 +83,7 @@
     # "collapse_navigation": not is_release_build,
     "show_prev_next": True,
     "navbar_align": "left",
+    "show_toc_level": 2,
     # social media links
     "icon_links": [
         {
@@ -91,7 +92,6 @@
             "icon": "fab fa-github-square",
         }
     ],
-    "primary_sidebar_end": [],
     "use_edit_page_button": True,
 }
 
@@ -103,9 +103,3 @@
     "github_repo": "https://github.com/sandialabs/pyscan",
     "github_version": "main",
 }
-
-html_sidebars = {
-    # default is
-    # "**": ["sidebar-nav-bs", "sidebar-ethical-ads"],
-    "**": ["sidebar-nav-bs"]
-}

pyscan/measurement/experiment.py

@@ -27,7 +27,6 @@ class Experiment(AbstractExperiment):
         The path to save the data, defaults to './backup'
     verbose: bool, optional
         Indicates whether to print status updates, defaults to `False`
-
     '''
 
     def __init__(self, runinfo, devices, data_dir=None, verbose=False, time=False):