diff --git a/ci/requirements/doc.yml b/ci/requirements/doc.yml index 8a76fae..a9908ce 100644 --- a/ci/requirements/doc.yml +++ b/ci/requirements/doc.yml @@ -5,10 +5,8 @@ channels: dependencies: - python=3.8 - dask - - docrep - ipython - matplotlib - - nbsphinx - numpy - numpydoc - pangeo-sphinx-book-theme @@ -17,6 +15,12 @@ dependencies: - sphinx-autosummary-accessors - sphinx-copybutton - xarray + # For examples + - adlfs + - ipykernel + - nbsphinx + - zarr + # Editable xbatcher installation - pip - pip: # relative to this file. Needs to be editable to be accepted. diff --git a/doc/conf.py b/doc/conf.py index a86a59b..7addfa4 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -54,9 +54,9 @@ "sphinx_copybutton", ] -# never execute notebooks: avoids lots of expensive imports on rtd +# only execute notebooks without any outputs # https://nbsphinx.readthedocs.io/en/0.2.14/never-execute.html -nbsphinx_execute = "never" +nbsphinx_execute = "auto" # http://stackoverflow.com/questions/5599254/how-to-use-sphinxs-autodoc-to-document-a-classs-init-self-method @@ -120,7 +120,7 @@ def setup(app): # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -exclude_patterns = ["_build"] +exclude_patterns = ["_build", "**.ipynb_checkpoints"] # The reST default role (used for this markup: `text`) to use for all # documents. diff --git a/doc/demo.ipynb b/doc/demo.ipynb index eea19e9..b0ec97d 100644 --- a/doc/demo.ipynb +++ b/doc/demo.ipynb @@ -386,22 +386,11 @@ "\n", "More thoughts on 1. and 2. can be found in [this issue](https://github.com/xarray-contrib/xbatcher/issues/30). Interested users are welcomed to comment or submit other issues in GitHub. " ] - }, - { - "cell_type": "code", - "execution_count": null, - "id": "6d685a90-3d07-4c07-bfdd-c85172a54daf", - "metadata": {}, - "outputs": [], - "source": [ - "%load_ext watermark\n", - "%watermark -iv" - ] } ], "metadata": { "kernelspec": { - "display_name": "Python 3", + "display_name": "Python 3.9.13 ('xbatcher-tests')", "language": "python", "name": "python3" }, @@ -415,11 +404,11 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.11.0 (main, Oct 24 2022, 17:48:40) [GCC 11.3.0]" + "version": "3.9.13" }, "vscode": { "interpreter": { - "hash": "af810c6721ae61030b73d9de2967bfb7a3088a28e7f243bda7b2d2ca2c498323" + "hash": "64c578a0a9f6dde4e1dfaddaa39417770d5e50fec039804eaf1eb97ef756c00c" } } },