CI: Save a requirements file for rerunning locally (#629)

* CI: Save the environment.txt file for rerunning locally
* CI: More verbose "missing external doc" error
* DOC: Prevent broken scikitlearn doc link
(see scikit-learn/scikit-learn#31804)

Author: Jacob-Stevens-Haas

.github/workflows/main.yml

@@ -83,6 +83,13 @@ jobs:
       run: |
         pip install --upgrade pip
         pip install .[dev,miosr,cvxpy,sbr]
+        pip freeze > environment.txt
+    - name: Save the environment
+      uses: actions/upload-artifact@v4
+      with:
+        name: requirements ${{matrix.python-version}}
+        path: environment.txt
+        retention-days: 5
     - name: Test with pytest
       run: |
         coverage run --source=pysindy -m pytest test -m "not slow"  && coverage xml

docs/conf.py

@@ -229,7 +229,7 @@ def fetch_notebook_list(base: str) -> list[tuple[str, str]]:
     """
     index = requests.get(base + "index.rst")
     if index.status_code != 200:
-        raise RuntimeError("Unable to locate external example directory")
+        raise RuntimeError(f"Unable to locate external example directory for {base}")
     text = str(index.content, encoding="utf-8")
     link_line = r"^\s+(.*)[^\S\r\n]+(\S+.ipynb)"
     T = TypeVar("T")

pyproject.toml

@@ -26,7 +26,7 @@ classifiers = [
 ]
 readme = "README.rst"
 dependencies = [
-    "scikit-learn>=1.1, !=1.5.0, !=1.6.0",
+    "scikit-learn>=1.1, !=1.5.0, !=1.6.0, !=1.7.1",
     "numpy>=2.0",
     "derivative>=0.6.2",
     "scipy",