fix #44, fix #45

Author: bckohan

.github/workflows/test.yml

@@ -36,6 +36,7 @@ jobs:
           virtualenvs-in-project: true
       - name: Install Dependencies
         run: |
+          sudo apt-get install libopenblas-dev
           poetry config virtualenvs.in-project true
           poetry run pip install --upgrade pip
           poetry install -E html -E png -E pdf
@@ -50,21 +51,20 @@ jobs:
       matrix:
         python-version: ['3.9', '3.10', '3.11', '3.12', '3.13.0-rc.1']
         sphinx-version:
-          - 'Sphinx~=7.0.0'
-          - 'Sphinx~=7.2.0'
-          - 'Sphinx~=7.3.0'
-          - 'Sphinx~=7.4.0'
+          - '6.0'
+          - '7.0'
+          - '8'
         exclude:
           - python-version: '3.12'
-            sphinx-version: 'Sphinx~=7.0.0'
-          - python-version: '3.13.0-rc.1'
-            sphinx-version: 'Sphinx~=7.0.0'
-          - python-version: '3.13.0-rc.1'
-            sphinx-version: 'Sphinx~=7.1.0'
+            sphinx-version: '7.0'
+          - python-version: '3.12'
+            sphinx-version: '6.0'
           - python-version: '3.13.0-rc.1'
-            sphinx-version: 'Sphinx~=7.2.0'
+            sphinx-version: '7.0'
           - python-version: '3.13.0-rc.1'
-            sphinx-version: 'Sphinx~=7.3.0'
+            sphinx-version: '6.0'
+          - python-version: '3.9'
+            sphinx-version: '8'
 
     steps:
     - uses: actions/checkout@v4
@@ -83,7 +83,7 @@ jobs:
         poetry config virtualenvs.in-project true
         poetry run pip install --upgrade pip
         poetry install -E html -E png -E pdf
-        poetry run pip install -U "${{ matrix.sphinx-version }}"
+        poetry run pip install -U "Sphinx~=${{ matrix.sphinx-version }}"
 
     - name: Install Emacs
       if: ${{ github.event.inputs.debug == 'on' }}

doc/source/changelog.rst

@@ -2,9 +2,11 @@
 Change Log
 ==========
 
-v0.4.3 (24-AUG-2024)
+v0.5.0 (24-AUG-2024)
 ====================
 
+* Implemented `Support Sphinx 8 <https://github.com/sphinx-contrib/typer/issues/45>`_
+* Implemented `Support Python 3.13 <https://github.com/sphinx-contrib/typer/issues/44>`_
 * Fixed `typer 0.12.5+ breaks click compatibility <https://github.com/sphinx-contrib/typer/issues/43>`_
 
 v0.4.2 (22-AUG-2024)

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "sphinxcontrib-typer"
-version = "0.4.3"
+version = "0.5.0"
 description = "Auto generate docs for typer commands."
 authors = ["Brian Kohan <[email protected]>"]
 license = "MIT"
@@ -11,7 +11,9 @@ classifiers = [
     "Development Status :: 5 - Production/Stable",
     "Environment :: Console",
     "Environment :: Web Environment",
+    "Framework :: Sphinx",
     "Framework :: Sphinx :: Extension",
+    "Topic :: Documentation :: Sphinx",
     "Intended Audience :: Developers",
     "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
@@ -32,11 +34,11 @@ packages = [
 
 [tool.poetry.dependencies]
 python = "^3.9"
-sphinx = ">=4.0.0"
+sphinx = ">=5.0.0"
 
 selenium = "^4.0.0"
 webdriver-manager = ">=3.0.0,<5.0.0"
-cairosvg = "^2.4.0"
+cairosvg = "^2.7.0"
 lxml = ">=4.2.0,<6.0.0"
 typer-slim = {extras = ["standard"], version = ">=0.12.0,<1.0.0"}
 pillow = ">=8.0.0"
@@ -45,33 +47,21 @@ pillow = ">=8.0.0"
 ruff = "^0.4.4"
 ipdb = "^0.13.13"
 pytest = ">=7.4.3,<9.0.0"
-pytest-cov = "^4.1.0"
+pytest-cov = "^5.0.0"
 doc8 = ">0.1"
-mypy = "^1.7.1"
-readme-renderer = {extras = ["md"], version = ">=42,<44"}
+mypy = "^1.11.1"
+readme-renderer = {extras = ["md"], version = ">=44"}
 aiohttp = "^3.9.1"
-numpy = [
-    { version = "^1.26", markers = "python_version > '3.8'" },
-    { version = "<=1.24", markers = "python_version <= '3.8'" },
-]
-scipy = [
-    { version = ">=1.11", markers = "python_version > '3.8'" },
-    { version = "<=1.10", markers = "python_version <= '3.8'" },
-]
-scikit-image = [
-    { version = ">=0.22", markers = "python_version > '3.8'" },
-    { version = "<=0.21", markers = "python_version <= '3.8'" },
-]
-typing-extensions = { version = ">=3.7.4.3", python = "<3.9" }
-scikit-learn = "^1.3.2"
+numpy = ">=2.0"
+scipy = ">=1.13"
+scikit-image = ">=0.24"
+typing-extensions = ">=4.12"
+scikit-learn = "^1.5.1"
 beautifulsoup4 = "^4.12.2"
 pypdf = ">=3.17.3,<5.0.0"
-sphinx-autobuild = [
-    { version = ">=2024.2.4", python = ">=3.9"},
-    { version = "<2024.2.4", python = "<3.9"},
-]
+sphinx-autobuild = ">=2024.4.16"
 furo = "^2024.8.6"
-sphinx-rtd-theme = "^2.0.0"
+sphinx-rtd-theme = ">=1.3.0"
 
 
 [tool.poetry.extras]

sphinxcontrib/typer/__init__.py

@@ -54,7 +54,7 @@
 from typer.models import Context as TyperContext
 from typer.models import TyperInfo
 
-VERSION = (0, 4, 3)
+VERSION = (0, 5, 0)
 
 __title__ = "SphinxContrib Typer"
 __version__ = ".".join(str(i) for i in VERSION)

tests/tests.py

@@ -1,6 +1,7 @@
 import pytest
 import re
 from sphinx.application import Sphinx
+from sphinx import version_info as sphinx_version
 from typer import __version__ as typer_version
 import typing as t
 import os
@@ -89,6 +90,7 @@ def replace_in_file(file_path: str, search_string: str, replacement_string: str)
         file.write(file_contents.replace(search_string, replacement_string))
 
 
+@pytest.mark.skipif(sphinx_version[0] < 6, reason="Sphinx >=6.0 required to build docs")
 def test_sphinx_html_build():
     """
     The documentation is extensive and exercises most of the features of the extension so