Merge pull request #236 from blink1073/cleanup-ci

Clean up CI and drop py3.7

.github/workflows/tests.yml

@@ -1,25 +1,36 @@
-name: continuous-integration
+name: tests
 
 on: [push, pull_request]
 
 jobs:
 
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v3
+      with:
+        python-version: 3.8
+    - uses: pre-commit/[email protected]
+
   tests:
 
     strategy:
       matrix:
-        python-version: [3.7, 3.8]
+        python-version: ["3.8", "3.9", "3.10", "3.11", " 3.12"]
         os: [ubuntu-latest]
         include:
           - os: windows-latest
-            python-version: 3.7
+            python-version: "3.12"
+          - os: macos-latest
+            python-version: "3.12"
 
     runs-on: ${{ matrix.os }}
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v3
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -33,6 +44,21 @@ jobs:
     - name: Run tests
       run: pytest
 
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v3
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install .
+      - name: Build docs
+        run: |
+          cd doc
+          make html-strict
+
   publish:
 
     name: Publish to PyPi
@@ -42,10 +68,10 @@ jobs:
     steps:
       - name: Checkout source
         uses: actions/checkout@v2
-      - name: Set up Python 3.7
+      - name: Set up Python 3.8
         uses: actions/setup-python@v1
         with:
-          python-version: 3.7
+          python-version: 3.8
       - name: Build package
         run: |
           pip install wheel

.readthedocs.yml

@@ -0,0 +1,10 @@
+version: 2
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.8"
+sphinx:
+  configuration: doc/source/conf.py
+python:
+  install:
+    - requirements: requirements.txt

doc/source/index.rst

@@ -90,7 +90,7 @@ LaTeX output:
 .. jupyter-execute::
 
   from IPython.display import Latex
-  Latex('\int_{-\infty}^\infty e^{-x²}dx = \sqrt{\pi}')
+  Latex('\\int_{-\\infty}^\\infty e^{-x²}dx = \\sqrt{\\pi}')
 
 or even full-blown javascript widgets:
 

requirements.txt

@@ -1,4 +1,4 @@
-sphinx>=2.4.4
+sphinx>=7.0
 ipykernel>=4.5.1
 ipywidgets>=7.0.0
 IPython

setup.py

@@ -29,13 +29,13 @@
     license="BSD",
     packages=["jupyter_sphinx"],
     install_requires=[
-        "Sphinx>=2",
+        "Sphinx>=7",
         "ipykernel>=4.5.1",
         "ipywidgets>=7.0.0",
         "IPython",
         "nbconvert>=5.5",
         "nbformat",
     ],
-    python_requires=">= 3.7",
+    python_requires=">= 3.8",
     package_data={"jupyter_sphinx": ["thebelab/*", "css/*"]},
 )

tests/test_execute.py

@@ -12,7 +12,13 @@
 from nbformat import from_dict
 from sphinx.addnodes import download_reference
 from sphinx.errors import ExtensionError
-from sphinx.testing.util import SphinxTestApp, assert_node, path
+from sphinx.testing.util import SphinxTestApp, assert_node
+
+try:
+    from sphinx.testing.util import path
+except ImportError:
+    path = None
+
 
 from jupyter_sphinx.ast import (
     JupyterCellNode,
@@ -47,8 +53,10 @@ def doctree(
         (src_dir / "index.rst").write_text(source, encoding="utf8")
 
         warnings = StringIO()
+        if path is not None:
+            src_dir = path(src_dir.as_posix())
         app = SphinxTestApp(
-            srcdir=path(src_dir.as_posix()),
+            srcdir=src_dir,
             status=StringIO(),
             warning=warnings,
             buildername=buildername,

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = py37
+envlist = py38,py39,py310,py311,py312
 
 [testenv]
 deps =