don't run notebooks

lbl-camera · Sep 14, 2023 · e311514 · e311514
1 parent c3ada53
commit e311514
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 15 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -39,6 +39,9 @@
     'sphinx.ext.napoleon'
 ]
 
+#if notebooks should not be executed:
+nb_execution_mode='off'
+
 # MyST extensions
 myst_enable_extensions = ['colon_fence']
 

diff --git a/fvgp/fvgp.py b/fvgp/fvgp.py
@@ -9,8 +9,6 @@
 from functools import partial
 from .gp import GP
 
-#TODO:
-#   adapt docs based on default kernel
 
 
 class fvGP(GP):
@@ -25,10 +23,6 @@ class provides all the methods described for the GP class.
     No... number of outputs
     N ... arbitrary integers (N1, N2,...)
 
-    ..
-    see gp.py for docstring instructions for developers
-    ..
-
 
     The main logic of fvGP is that any multi-task GP is just a single-task GP
     over a Cartesian product space of input and output space, as long as the kernel

diff --git a/fvgp/gp.py b/fvgp/gp.py
@@ -29,9 +29,6 @@
 
 
 
-
-#TODO:
-
 class GP():
     """
     This class provides all the tools for a single-task Gaussian Process (GP).
@@ -42,12 +39,6 @@ class GP():
     D ... input space dimensionality
     N ... arbitrary integers (N1, N2,...)
 
-    ..
-    instructions for docstings (for developers):
-    this class: fvgp.GP
-    callable descriptions: name(input1, input2, input3), where input1 is ..., input2 is ...
-    Use described symbols above, otherwise describe used symbol.
-    ..
 
     Parameters
     ----------