Skip to content

Commit 1264815

Browse files
committed
Prepare v1.1.1 release
- Update version to 1.1.1 in __init__.py - Finalize CHANGELOG with v1.1.1 entry - Add comprehensive v1.1.1 release notes - Update releases documentation index This patch release restores Python 3.10 support with full test coverage across Python 3.10-3.13 and Sphinx 6-8.
1 parent a15ae24 commit 1264815

File tree

4 files changed

+81
-1
lines changed

4 files changed

+81
-1
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,16 @@
22

33
## [Unreleased]
44

5+
## [v1.1.1](https://github.com/executablebooks/sphinx-exercise/tree/v1.1.1) (2025-10-23)
6+
57
### Improved 👌
68

79
- **Restored Python 3.10 support** - Re-added compatibility with Python 3.10 as it remains actively supported until October 2026
810
- Updated test matrix to include Python 3.10 with Sphinx 6, 7, and 8
911
- Test matrix now covers 11 combinations (excludes Python 3.13 + Sphinx 6 due to deprecation warnings)
1012
- **Note**: Python 3.10 is limited to Sphinx 8.1.x (max 8.1.3) due to Sphinx 8.2+ requiring Python >=3.11. This is handled automatically in the test configuration.
13+
- Updated codecov integration to use Python 3.12 + Sphinx 8 baseline
14+
- Configured tokenless codecov uploads for public repository
1115

1216
## [v1.1.0](https://github.com/executablebooks/sphinx-exercise/tree/v1.1.0) (2025-10-22)
1317

docs/source/releases/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ This section contains detailed release notes for sphinx-exercise versions.
55
```{toctree}
66
:maxdepth: 1
77
8+
v1.1.1
89
v1.1.0
910
```
1011

docs/source/releases/v1.1.1.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Release v1.1.1
2+
3+
**Release Date**: October 23, 2025
4+
5+
This is a patch release that restores Python 3.10 compatibility while maintaining support for newer Python versions.
6+
7+
## 👌 Improvements
8+
9+
### Python 3.10 Support Restored
10+
11+
Python 3.10 support has been re-added to the project. Python 3.10 remains actively supported until October 2026, making it an important version to maintain compatibility with.
12+
13+
**Key details:**
14+
- Python 3.10 is now fully supported alongside Python 3.11, 3.12, and 3.13
15+
- All existing features work identically across all supported Python versions
16+
- Comprehensive test coverage ensures compatibility
17+
18+
### Technical Implementation
19+
20+
**Version-Specific Sphinx Constraints:**
21+
- Python 3.10 is limited to **Sphinx 8.1.x** (maximum 8.1.3)
22+
- Python 3.11+ continues to use **Sphinx 8.2+** as normal
23+
- This constraint exists because Sphinx 8.2.0+ requires Python >=3.11
24+
25+
The test infrastructure automatically handles these version-specific requirements, ensuring correct behavior across all combinations.
26+
27+
### Test Matrix Updates
28+
29+
**Supported Combinations:**
30+
- Python 3.10, 3.11, 3.12: Sphinx 6, 7, 8
31+
- Python 3.13: Sphinx 7, 8
32+
33+
**Total: 11 test environments** (excludes Python 3.13 + Sphinx 6)
34+
35+
Python 3.13 + Sphinx 6 was excluded because Sphinx 6.2.1 generates 1870+ deprecation warnings on Python 3.13 due to its use of deprecated `datetime.utcfromtimestamp()`. This is an unlikely real-world combination.
36+
37+
### CI/CD Improvements
38+
39+
- Updated GitHub Actions CI matrix to include Python 3.10
40+
- Configured codecov to use Python 3.12 + Sphinx 8 as baseline
41+
- Implemented tokenless codecov uploads for public repository
42+
- Added version-specific test fixtures for Sphinx 8.1 vs 8.2+ compatibility
43+
44+
## 📦 Installation
45+
46+
Install or upgrade via pip:
47+
48+
```bash
49+
pip install --upgrade sphinx-exercise
50+
```
51+
52+
## 🔄 Migration Notes
53+
54+
**If you're upgrading from v1.1.0:**
55+
- No breaking changes
56+
- No action required
57+
- Python 3.10 users can now upgrade safely
58+
59+
**If you're on Python 3.10:**
60+
- You can now use sphinx-exercise v1.1.1
61+
- Sphinx 8 support is limited to 8.1.x on Python 3.10
62+
- All features work identically to newer Python versions
63+
64+
## 🐛 Bug Fixes
65+
66+
- Fixed test fixtures to handle Sphinx 8.1.x vs 8.2+ XML output differences
67+
- Ensured consistent test behavior across all Python/Sphinx combinations
68+
69+
## 📝 Full Changelog
70+
71+
For complete details, see the [CHANGELOG.md](https://github.com/executablebooks/sphinx-exercise/blob/main/CHANGELOG.md).
72+
73+
## 🙏 Acknowledgments
74+
75+
Thank you to all contributors and users who reported the need for Python 3.10 support!

sphinx_exercise/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
:license: MIT, see LICENSE for details.
88
"""
99

10-
__version__ = "1.1.0"
10+
__version__ = "1.1.1"
1111

1212
from pathlib import Path
1313
from typing import Any, Dict, Set, Union, cast

0 commit comments

Comments
 (0)