Merge pull request #48 from SmithChart/sphinx-fix-release

plugins/Sphinx: Work around Sphinx using new config format
pengutronix · Apr 25, 2024 · b266b4a · b266b4a
2 parents 21b6a62 + 2e45b98
commit b266b4a
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 2 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -3,6 +3,22 @@
 Changelog
 =========
 
+`v1.10.1 <https://github.com/pengutronix/flamingo/compare/v1.10...v1.10.1>`_ (2024-04-23)
+-----------------------------------------------------------------------------------------
+
+Changes
+~~~~~~~
+
+(none)
+
+Bugfixes
+~~~~~~~~
+
+* plugins/Sphinx: Sphinx 7.3.0 has introduced a
+  `new configuration format <https://github.com/sphinx-doc/sphinx/pull/12265>`__ for themes.
+  This breaks the way we parse the theme configuration.
+  For this bugfix release we pin the Sphinx dependency to :code:`<7.3.0` to work around this problem.
+
 `v1.10 <https://github.com/pengutronix/flamingo/compare/v1.9...v1.10>`_ (2024-04-22)
 ------------------------------------------------------------------------------------
 

diff --git a/flamingo/__init__.py b/flamingo/__init__.py
@@ -5,7 +5,7 @@
 
 _dirname = os.path.dirname(__file__)
 
-VERSION = (1, 10)
+VERSION = (1, 10, 1)
 VERSION_STRING = '.'.join([str(i) for i in VERSION])
 THEME_ROOT = os.path.join(_dirname, 'theme')
 PROJECT_TEMPLATES_ROOT = os.path.join(_dirname, 'project_templates')

diff --git a/setup.py b/setup.py
@@ -41,7 +41,7 @@
         'coloredlogs',
     ],
     'sphinx-themes': [
-        'sphinx>=4.5.0',
+        'sphinx>=4.5.0,<7.3.0',
         'sphinx_rtd_theme>=1.0.0',
     ],
 }