test: added a test for the jupyter notebooks in the examples folder in the CIs

small fix


 small fix


fix

Author: AldoGl

.github/workflows/docs.yml

@@ -0,0 +1,27 @@
+name: docs
+
+on:
+  push:
+    branches:
+      - opensource
+      - main
+  pull_request:
+
+jobs:
+  test-notebooks-examples:
+    continue-on-error: True
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+
+    steps:
+      - uses: actions/checkout@master
+      - uses: actions/setup-python@master
+        with:
+          python-version: 3.7
+      - name: Install dependencies
+        run: |
+          pip install -e ."[dev]"
+
+      - name: Notebook tests
+        run: |
+          tox -e py3.7-nb

Makefile

@@ -12,6 +12,9 @@ black: ## apply black formatting
 black-check: ## check black formatting
 	black --check --verbose dadapy tests
 
+flake8: ## check style with flake8
+	flake8 dadapy/base.py dadapy/metric_comparisons.py dadapy/clustering.py dadapy/id_estimation.py dadapy/density_estimation tests #dev_scripts examples
+
 # to include the "dadapy" folder: pytest tests --doctest-modules dadapy tests/
 test: ## run tests quickly with the default Python
 	pytest tests --doctest-modules tests/ \
@@ -23,20 +26,12 @@ test: ## run tests quickly with the default Python
 test-all: ## run tests on every Python version with tox
 	tox
 
+test-nb: ## test notebooks in the examples folder
+	pytest examples/notebook_on_intrinsicdim_densityest_clustering.ipynb examples/notebook_on_information_imbalance.ipynb --nbmake --nbmake-timeout=300
+
 coverage: ## check code coverage quickly with the default Python
 	coverage run --source dadapy -m pytest
 	coverage report -m
 	coverage html
 	$(BROWSER) htmlcov/index.html
 
-flake8: ## check style with flake8
-	flake8 dadapy/base.py dadapy/metric_comparisons.py dadapy/clustering.py dadapy/id_estimation.py dadapy/density_estimation.py tests #dev_scripts examples
-
-#pylint: ## run pylint
-#	pylint dadapy tests
-#
-#vulture: ## run vulture
-#	vulture dadapy dev_scripts/whitelist.py
-#
-#darglint: ## run vulture
-#	darglint dadapy

tox.ini

@@ -70,3 +70,11 @@ deps =
     pydocstyle
 commands =
     flake8 dadapy/base.py dadapy/metric_comparisons.py dadapy/clustering.py dadapy/id_estimation.py dadapy/density_estimation.py tests
+
+[testenv:py3.7-nb]
+basepython = python3.7
+deps =
+    pytest>=6.2.5,<6.3.0
+    nbmake>=1.2,<1.3
+commands:
+    pytest examples/notebook_on_intrinsicdim_densityest_clustering.ipynb examples/notebook_on_information_imbalance.ipynb --nbmake --nbmake-timeout=300