remove sphinx-autoapi, add note, update CHANGELOG.rst

hydrologie · Feb 24, 2025 · 8973d12 · 8973d12
1 parent b4c7d8d
commit 8973d12
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 4 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -25,6 +25,7 @@ Internal changes
     * GitHub Actions versions and Python dependencies updated.
     * Added pre-commit hooks for `vulture` (find dead code), `codespell` (spelling mistakes), `gitleaks` (token commit prevention), and `zizmor` (workflow security).
     * Added an advanced CodeQL workflow for security scanning.
+* Adjusted a handful of dependency pins to handle the latest version of `sphinx`. (:pull:`258`).
 
 v0.4.1 (2024-11-07)
 -------------------

diff --git a/environment-dev.yml b/environment-dev.yml
@@ -64,8 +64,7 @@ dependencies:
   - pytest-xdist >=3.2
   - ruff >=0.9.0
   - watchdog >=4.0.0
-  - sphinx >=7.1.0,<8.2.0
-  - sphinx-autoapi
+  - sphinx >=7.1.0,<8.2.0  # Pinned until nbsphinx supports Sphinx 8.2
   - sphinx-codeautolink >=0.16.2
   - sphinx-copybutton
   - sphinx-intl

diff --git a/pyproject.toml b/pyproject.toml
@@ -99,8 +99,7 @@ docs = [
   "jupyter_client",
   "nbsphinx >=0.9.5",
   "nbval",
-  "sphinx >=7.1.0,<8.2.0",
-  "sphinx-autoapi",
+  "sphinx >=7.1.0,<8.2.0", # Pinned until nbsphinx supports Sphinx 8.2
   "sphinx-codeautolink >=0.16.2",
   "sphinx-copybutton",
   "sphinx-intl",