Skip to content

Commit 2b3f317

Browse files
committed
feat(deps): allow Sphinx 5/6/7 and sphinx-rtd-theme 2.x/3.x
Widen install_requires to sphinx>=4.5,<9 and sphinx_rtd_theme>=2.0,<4 so SpongeDocs can move past the docutils<0.18 pin that RTD-theme 1.0 carried. No template or CSS changes — the RTD-theme class names and overridden blocks this theme hooks into are unchanged in the target versions. Bumps version to 1.2.0. Signed-off-by: Gabriel Harris-Rouquette <gabizou@me.com>
1 parent 72dae7f commit 2b3f317

3 files changed

Lines changed: 21 additions & 2 deletions

File tree

CHANGELOG.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Changelog
2+
3+
## 1.2.0
4+
5+
- Bump `install_requires` to `sphinx-rtd-theme>=2.0,<4` and `sphinx>=4.5,<9` so
6+
the theme installs alongside modern Sphinx (5.x / 6.x / 7.x).
7+
`sphinx-rtd-theme 1.0` pinned `docutils<0.18`, which blocked SpongeDocs from
8+
upgrading past Sphinx 4.5.
9+
- No template or CSS changes. The RTD-theme 2.x/3.x class names this theme
10+
hooks into (`wy-*`, `rst-versions`, `rst-current-version`, `rst-other-versions`,
11+
`rst-footer-buttons`, `headerlink`) and the overridden block (`sidebartitle`)
12+
are unchanged in the target versions.
13+
14+
## 1.1.0 and earlier
15+
16+
See Git history.

setup.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,10 @@
1010
license='MIT',
1111

1212
packages=['sponge_docs_theme'],
13-
install_requires=['sphinx_rtd_theme==1.0.0'],
13+
install_requires=[
14+
'sphinx>=4.5,<9',
15+
'sphinx_rtd_theme>=2.0,<4',
16+
],
1417

1518
message_extractors={
1619
'src/theme/js': [

src/theme/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
VERSION = (1, 1, 0)
1+
VERSION = (1, 2, 0)
22
__version__ = '.'.join(str(v) for v in VERSION)
33

44

0 commit comments

Comments
 (0)