Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support Sphinx>=5.0.0 & Python 3.13 #30

Merged
merged 12 commits into from
Feb 7, 2025
17 changes: 14 additions & 3 deletions .github/workflows/test_build_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,20 @@ jobs:
strategy:
fail-fast: false
matrix:
python-version: ["3.9", "3.10", "3.11", "3.12"]
python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
docs-dir: ["doc", "doc_copybutton"]
sphinx-ver: ["4.5.0", "5.3.0", "6.2.1", "7.2.6"]
sphinx-ver: [
"sphinx==5.3.0",
"sphinx==6.2.1",
"sphinx==7.2.6",
"sphinx==8.1.3",
"sphinx", # Latest
]
exclude:
- python-version: "3.13"
sphinx-ver: "sphinx==5.3.0"
- python-version: "3.9"
sphinx-ver: "sphinx==8.1.3"

steps:

Expand All @@ -26,7 +37,7 @@ jobs:
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install sphinx==${{ matrix.sphinx-ver }}
python -m pip install ${{ matrix.sphinx-ver }}
pip install .
pip install -r ${{ matrix.docs-dir }}/requirements.txt

Expand Down
8 changes: 8 additions & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,14 @@ There's an example of this in the doc_copybutton folder.
Changelog
================================

V0.6.0 - 07-feb-2025
-----------------------

- Added support for Sphinx 8.x
- CI tests with Python 3.13
- Drop <8 sphinx version limit - now, any sphinx 5.0.0 or later is allowed.


V0.5.2 - 07-jan-2024
-----------------------

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,6 @@
classifiers=["License :: OSI Approved :: MIT License"],
python_requires=">=3.9",
install_requires=[
"sphinx>=4.5.0,<8",
"sphinx>=5.0.0",
]
)
2 changes: 1 addition & 1 deletion sphinx_toggleprompt/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
from pathlib import Path


__version__ = "0.5.2"
__version__ = "0.6.0"
logger = logging.getLogger(__name__)


Expand Down