Update documentation to use myst-nb~=0.7 (#46)

.vscode/settings.json

@@ -14,6 +14,6 @@
     "python.linting.pylintEnabled": false,
     "python.linting.flake8Enabled": true,
     "python.linting.enabled": true,
-    "python.pythonPath": "/anaconda/envs/mistune/bin/python",
+    "python.pythonPath": "/anaconda/envs/ebp/bin/python",
     "autoDocstring.customTemplatePath": "docstring.fmt.mustache"
 }

docs/conf.py

@@ -29,13 +29,13 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    "myst_parser",
     "myst_nb",
     "sphinx.ext.intersphinx",
     "sphinx_copybutton",
     # "sphinx.ext.autodoc",
     # "sphinx.ext.viewcode",
 ]
+jupyter_execute_notebooks = "off"
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
@@ -65,7 +65,7 @@
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
-html_css_files = ["css/custom.css"]
+# html_css_files = ["css/custom.css"]
 
 
 intersphinx_mapping = {"python": ("https://docs.python.org/3.7", None)}
@@ -77,8 +77,3 @@
     ("py:class", "ForwardRef"),
     ("py:class", "NoneType"),
 ]
-
-
-def setup(app):
-    """Add functions to the Sphinx setup."""
-    # app.connect("builder-inited", run_apidoc)

docs/index.md

@@ -52,7 +52,7 @@ Here are the site contents:
 maxdepth: 2
 caption: Contents
 ---
-using/cli.md
-using/api.ipynb
-develop/contributing.md
+using/cli
+using/api
+develop/contributing
 ```

jupyter_cache/cache/main.py

@@ -418,6 +418,8 @@ def discard_staged_notebook(self, uri_or_pk: Union[int, str]):
         else:
             NbStageRecord.remove_uris([uri_or_pk], self.db)
 
+    # TODO add discard all/multiple staged records method
+
     def get_staged_notebook(
         self, uri_or_pk: Union[int, str], converter: Optional[Callable] = None
     ) -> NbBundleIn:

jupyter_cache/executors/base.py

@@ -42,7 +42,7 @@ def run_and_cache(
         filter_pks: Optional[List[int]] = None,
         converter: Optional[Callable] = None,
     ) -> List[NbCacheRecord]:
-        """Run execution, stage successfully executed notebooks and return their URIs
+        """Run execution, cache successfully executed notebooks and return their URIs
 
         Parameters
         ----------

setup.py

@@ -46,7 +46,7 @@
         "cli": ["click", "click-completion", "click-log", "tabulate", "pyyaml"],
         "code_style": ["flake8<3.8.0,>=3.7.0", "black", "pre-commit==1.17.0"],
         "testing": ["coverage", "pytest>=3.6,<4", "pytest-cov", "pytest-regressions"],
-        "rtd": ["myst-nb~=0.2.1", "sphinx-copybutton", "pydata-sphinx-theme"],
+        "rtd": ["myst-nb~=0.7", "sphinx-copybutton", "pydata-sphinx-theme"],
     },
     zip_safe=True,
 )