Use nbsphinx to render .ipynb in docs

Fixes #1278
opendatacube · Jun 22, 2022 · ffb7349 · ffb7349
1 parent b8b4afd
commit ffb7349
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 9 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -39,4 +39,4 @@ livehtml:
 
 clean:
 	rm -rf _build/
-	rm -rf dev/api/generate/*
+	rm -rf dev/api/generate data-access-analysis/apis/generate api/indexed-data/generate api/geometry/generate
diff --git a/docs/click_utils.py b/docs/click_utils.py
@@ -77,3 +77,8 @@ def setup(app):
     app.add_config_value('click_utils_commands', {}, 'html')
 
     app.add_domain(DatacubeDomain)
+    return {
+        'parallel_read_safe': False,
+        'parallel_write_safe': False,
+    }
+
diff --git a/docs/conf.py b/docs/conf.py
@@ -35,6 +35,7 @@
     'sphinx_click.ext',
     'click_utils',
     'autodocsumm',
+    'nbsphinx',
     'sphinx.ext.napoleon'
 ]
 
@@ -68,7 +69,7 @@
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['README.rst']
+exclude_patterns = ['README.rst', '.condaenv', '.direnv']
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
 add_function_parentheses = True

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,9 +1,7 @@
-paramiko>=2.10.1
 Sphinx==4.1.2
 sphinx-autodoc-typehints==1.12.0
 autodocsumm==0.2.6
 sphinx-click==3.0.1
-sphinx-rtd-theme==0.4.3
 pydata-sphinx-theme==0.6.3
-sshtunnel==0.1.5
 beautifulsoup4==4.9.3
+nbsphinx==0.8.9
diff --git a/docs/rtd-requirements.txt b/docs/rtd-requirements.txt
@@ -31,14 +31,14 @@ jsonschema==4.5.1
 lark-parser==0.12.0
 MarkupSafe==2.1.1
 msgpack==1.0.3
+nbsphinx==0.8.9
 netCDF4==1.5.8
 numpy==1.22.3
 packaging==21.3
 pandas==1.4.2
-paramiko>=2.10.1
 pbr==5.4.5
 psutil==5.9.0
-psycopg2==2.9.3
+psycopg2-binary==2.9.3
 pydata-sphinx-theme==0.8.1
 pycparser==2.21
 Pygments==2.12.0
@@ -62,15 +62,13 @@ sortedcontainers==2.4.0
 Sphinx==4.5.0
 sphinx-autodoc-typehints==1.18.1
 sphinx-click==4.0.3
-sphinx-rtd-theme==1.0.0
 sphinxcontrib-applehelp==1.0.2
 sphinxcontrib-devhelp==1.0.2
 sphinxcontrib-htmlhelp==2.0.0
 sphinxcontrib-jsmath==1.0.1
 sphinxcontrib-qthelp==1.0.3
 sphinxcontrib-serializinghtml==1.1.5
 SQLAlchemy==1.4.36
-sshtunnel==0.1.5
 tblib==1.6.0
 toml==0.10.2
 toolz==0.11.2