diff --git a/.vscode/settings.json b/.vscode/settings.json index d0c4bd3..bade39f 100644 --- a/.vscode/settings.json +++ b/.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" } diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css deleted file mode 100644 index 0b5337a..0000000 --- a/docs/_static/css/custom.css +++ /dev/null @@ -1,4 +0,0 @@ -div.cell div.cell_input { - border-left-color: green; - border-left-width: medium; -} diff --git a/docs/conf.py b/docs/conf.py index d03f04a..16ccc2d 100644 --- a/docs/conf.py +++ b/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) diff --git a/docs/index.md b/docs/index.md index 191ef6e..dac04f9 100644 --- a/docs/index.md +++ b/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 ``` diff --git a/jupyter_cache/cache/main.py b/jupyter_cache/cache/main.py index 5e99be3..deb9b83 100644 --- a/jupyter_cache/cache/main.py +++ b/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: diff --git a/jupyter_cache/executors/base.py b/jupyter_cache/executors/base.py index 5574b6a..17dd69b 100644 --- a/jupyter_cache/executors/base.py +++ b/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 ---------- diff --git a/setup.py b/setup.py index fe4238a..5d5a53d 100644 --- a/setup.py +++ b/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, )