add workflow to build docs

Author: ianhi

.github/workflows/docs.yml

@@ -0,0 +1,33 @@
+name: Docs
+
+on: [push, pull_request]
+
+
+defaults:
+  run:
+    shell: bash -l {0}
+jobs:
+  build:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup conda
+        uses: conda-incubator/setup-miniconda@v2
+        with:
+          activate-environment: ipympl-dev
+          environment-file: dev-environment.yml
+          python-version: ${{ matrix.python-version }}
+          mamba-version: "*"
+          auto-activate-base: false
+          channels: conda-forge
+      - name: Install
+        run: python -m pip install -v .[docs]
+      - name: Build
+        run: make -C docs html
+      - name: Publish
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/_build/html
+          force_orphan: true

docs/conf.py

@@ -34,13 +34,11 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    "jupyter_sphinx",
     "myst_nb",
     "sphinx.ext.intersphinx",
     "sphinx.ext.linkcode",
     "sphinx.ext.mathjax",
     "sphinx_copybutton",
-    "sphinx_panels",
     "sphinx_thebe",
     "sphinx_togglebutton",
 ]
@@ -59,8 +57,6 @@
     "python": ("https://docs.python.org/3", None),
 }
 
-# remove panels css to get wider main content
-panels_add_bootstrap_css = False
 
 # Settings for copybutton
 copybutton_prompt_is_regexp = True

setup.py

@@ -66,12 +66,11 @@
         'ipywidgets>=7.6.0,<8',
         'matplotlib>=2.0.0,<4',
     ],
-    extra_requires={
+    extras_require={
         "docs": [
             "myst-nb",
             "Sphinx >= 1.5",
             "sphinx-copybutton",
-            "sphinx-panels",
             "sphinx-thebe",
             "sphinx-togglebutton",
             "sphinx-book-theme",