[MAINT] Use Github Actions for docs (#67)

.github/workflows/documentation.yml

@@ -0,0 +1,35 @@
+name: docs
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+# workflow_dispatch: # Uncomment line to be able to trigger action manually
+
+jobs:
+  sphinx_docs_to_gh-pages:
+    runs-on: ubuntu-latest
+    name: deploy to gh-pages
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+          cache: "pip"
+      - name: Install meegkit and dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install -e .[docs]
+      - name: Build HTML
+        run: |
+          cd doc/
+          make html
+      - name: Run ghp-import
+        run: |
+          ghp-import -n -p -f doc/_build/html

.github/workflows/pythonpackage.yml → .github/workflows/testing.yml

@@ -1,4 +1,4 @@
-name: unit-tests
+name: tests
 
 on:
   push:
@@ -14,7 +14,7 @@ jobs:
     strategy:
       max-parallel: 4
       matrix:
-        python-version: [3.7, 3.8, 3.9]
+        python-version: ["3.9", "3.10", "3.11"]
 
     steps:
     - uses: actions/checkout@v1

README.md

@@ -1,5 +1,5 @@
-[![unit-tests](https://github.com/nbara/python-meegkit/workflows/unit-tests/badge.svg?style=flat)](https://github.com/nbara/python-meegkit/actions?workflow=unit-tests)
-[![documentation](https://img.shields.io/travis/nbara/python-meegkit.svg?label=documentation&logo=travis)](https://www.travis-ci.com/github/nbara/python-meegkit)
+[![tests](https://github.com/nbara/python-meegkit/workflows/tests/badge.svg?style=flat)](https://github.com/nbara/python-meegkit/actions?workflow=tests)
+[![docs](https://github.com/nbara/python-meegkit/workflows/docs/badge.svg?style=flat)](https://github.com/nbara/python-meegkit/actions?workflow=docs)
 [![codecov](https://codecov.io/gh/nbara/python-meegkit/branch/master/graph/badge.svg)](https://codecov.io/gh/nbara/python-meegkit)
 [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/nbara/python-meegkit/master)
 [![DOI](https://zenodo.org/badge/117451752.svg)](https://zenodo.org/badge/latestdoi/117451752)

citation.cff

@@ -5,7 +5,7 @@ authors:
   given-names: "Nicolas"
   orcid: "https://orcid.org/0000-0003-1495-561X"
 title: "MEEGkit"
-version: 0.1.1
+version: 0.1.3
 doi: 10.5281/zenodo.5643659
 date-released: 2021-10-15
 url: "https://github.com/nbara/python-meegkit"

setup.cfg

@@ -20,6 +20,5 @@ upload-dir = doc/_build/html
 
 [options.extras_require]
 extra = pymanopt
-docs = sphinx;sphinx-gallery;sphinx-bootstrap_theme;sphinx-copybutton;sphinxemoji;numpydoc;pydata-sphinx-theme;pillow;jupyter-sphinx;meegkit[extra]
+docs = sphinx;sphinx-gallery;sphinx-bootstrap_theme;sphinx-copybutton;sphinxemoji;numpydoc;pydata-sphinx-theme;pillow;jupyter-sphinx;ghp-import;meegkit[extra]
 tests = pytest;pytest-cov;codecov;codespell;flake8;pydocstyle;meegkit[extra]
-

setup.py

@@ -22,7 +22,7 @@
         "Tracker": "https://github.com/nbara/python-meegkit/issues/",
     },
     platforms="any",
-    python_requires=">=3.7",
+    python_requires=">=3.8",
     install_requires=["numpy", "scipy", "scikit-learn", "joblib", "pandas",
                       "matplotlib", "tqdm", "pyriemann", "statsmodels"],
     zip_safe=False)

tests/test_asr.py

@@ -243,8 +243,8 @@ def test_asr_class(method, reref, show=False):
         plt.show()
 
     # TODO: the transform() process is stochastic, so Y and Y2 are not going to
-    # be entirely idetntical but close enough
-    assert np.all(np.abs(Y - Y2) < 5), np.max(np.abs(Y - Y2))  # < 5uV diff
+    # be entirely identical but close enough
+    assert np.all(np.abs(Y - Y2) < 6), np.max(np.abs(Y - Y2))  # < 6uV diff
     assert np.all(np.isreal(Y)), "output should be real-valued"
     assert np.all(np.isreal(Y2)), "output should be real-valued"
 
@@ -261,5 +261,5 @@ def test_asr_class(method, reref, show=False):
     pytest.main([__file__])
     # test_yulewalk(250, True)
     # test_asr_functions(True)
-    # test_asr_class(method='riemann', reref=False, show=True)
+    # test_asr_class(method='riemann', reref=True, show=False)
     # test_yulewalk_filter(16, True)