Fix Sphinx config-mode version handling

Keep SphinxConfigVersion.cmake for config-mode checks without hard-coding a
build-time sphinx version. Version discovery remains dynamic via
FindSphinx.cmake. SphinxConfig.cmake stays a thin entry point. Wheel
distribution is supported.

Add compatibility to latest Sphinx and Cmake versions

Author: buddly27

.github/workflows/release.yml

@@ -30,7 +30,7 @@ jobs:
 
       - name: Build package
         run: |
-          python -m build --sdist
+          python -m build
 
       - name: Check metadata
         run: twine check dist/*

.github/workflows/test.yml

@@ -16,15 +16,10 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        sphinx: [ "5", "6", "7", "8" ]
+        sphinx: [ "6", "7", "8", "9" ]
         cmake: [ "3.20", "4.1" ]
         os: [ "ubuntu", "macos", "windows" ]
-        python: [ "3.8", "3.12", "3.13" ]
-        exclude:
-          - sphinx: "8"
-            python: "3.8"
-          - sphinx: "5"
-            python: "3.13"
+        python: [ "3.10", "3.14" ]
 
     name: |
       v${{ matrix.sphinx }}-${{ matrix.cmake }}

README.md

@@ -1,7 +1,7 @@
 # Sphinx CMake
 
 [![PyPi version](https://img.shields.io/pypi/v/sphinx-cmake.svg?logo=pypi&label=PyPI&logoColor=gold)](https://pypi.python.org/pypi/sphinx-cmake)
-[![CMake](https://img.shields.io/badge/CMake-3.20...4.1-blue.svg?logo=CMake&logoColor=blue)](https://cmake.org)
+[![CMake](https://img.shields.io/badge/CMake-3.20...4.2-blue.svg?logo=CMake&logoColor=blue)](https://cmake.org)
 [![Test](https://github.com/python-cmake/sphinx-cmake/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/python-cmake/sphinx-cmake/actions/workflows/test.yml)
 [![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 

build_config.py

@@ -1,15 +1,13 @@
 from hatchling.builders.hooks.plugin.interface import BuildHookInterface
 
 import pathlib
-import subprocess
 
 
 class BuildConfig(BuildHookInterface):
     """Builder to create and share sphinx config."""
 
     def initialize(self, version, build_data):
         """Execute builder."""
-        import sphinx
 
         root = pathlib.Path(__file__).parent.resolve()
         build_path = (root / "build")
@@ -25,18 +23,10 @@ def initialize(self, version, build_data):
                 "include(${CMAKE_CURRENT_LIST_DIR}/FindSphinx.cmake)\n"
             )
 
-        # Generate CMake config version file for client to target a specific
-        # version of Sphinx within CMake projects.
-        version_config_path = (build_path / "SphinxConfigVersion.cmake")
-        script_path = (build_path / "SphinxConfigVersionScript.cmake")
-        with script_path.open("w", encoding="utf-8") as stream:
+        # Always accept; actual version checks are handled by FindSphinx.cmake
+        config_path = (build_path / "SphinxConfigVersion.cmake")
+        with config_path.open("w", encoding="utf-8") as stream:
             stream.write(
-                "include(CMakePackageConfigHelpers)\n"
-                "write_basic_package_version_file(\n"
-                f"    \"{str(version_config_path.as_posix())}\"\n"
-                f"    VERSION {sphinx.__version__}\n"
-                "    COMPATIBILITY AnyNewerVersion\n"
-                ")"
+                "set(PACKAGE_VERSION_COMPATIBLE TRUE)\n"
+                "set(PACKAGE_VERSION_EXACT TRUE)\n"
             )
-
-        subprocess.call(["cmake", "-P", str(script_path), "-VV"])

cmake/FindSphinx.cmake

@@ -16,7 +16,7 @@
 #     prepend a custom search path.
 #     (https://cmake.org/cmake/help/latest/policy/CMP0074.html)
 
-cmake_minimum_required(VERSION 3.20...4.1)
+cmake_minimum_required(VERSION 3.20...4.2)
 
 include(FindPackageHandleStandardArgs)
 

doc/installing.rst

@@ -60,20 +60,3 @@ Then, build the documentation with the command::
 View the result in your browser at::
 
     file:///path/to/sphinx-build/build/doc/html/index.html
-
-.. _installing/deployment:
-
-Package Deployment
-==================
-
-This package is deployed as a source on `PyPi <https://pypi.org/project/sphinx-cmake/>`_
-to allow dynamic adaptation of :term:`CMake` scripts based on the version of :term:`Sphinx`
-available at installation. Packaging it as a
-`wheel <https://packaging.python.org/en/latest/specifications/binary-distribution-format>`_
-would lock the :term:`Sphinx` version detected during the packaging and deployment process,
-reducing flexibility and compatibility with future versions.
-
-If you wish to deploy the package as a source within a custom index, it is important to include
-the build requirements in your environment (e.g. "hatchling" and "cmake").
-
-.. seealso:: `Package Formats <https://packaging.python.org/en/latest/discussions/package-formats>`_

doc/release/release_notes.rst

@@ -11,6 +11,19 @@ Release Notes
         Added support for prepending library and Python paths, and for passing
         arbitrary environment variables to Sphinx builds.
 
+    .. change:: new
+
+        Added compatibility with Sphinx v9 and CMake 4.2.
+
+    .. change:: changed
+
+        Updated :term:`CMake` packaging by simplifying
+        `SphinxConfigVersion.cmake` so that version compatibility is no longer
+        fixed at build time. Version discovery and validation are handled
+        dynamically by `FindSphinx.cmake`, with `SphinxConfig.cmake` serving
+        only as a thin entry point for :term:`CMake` package discovery.
+        Wheel distribution is fully supported and recommended.
+
 .. release:: 1.0.1
     :date: 2025-08-14
 

pyproject.toml

@@ -1,7 +1,7 @@
 [build-system]
 requires = [
     "hatchling >= 1.4",
-    "cmake >= 3.20, < 4.2"
+    "cmake >= 3.20, < 4.3"
 ]
 build-backend = "hatchling.build"
 
@@ -17,7 +17,7 @@ authors = [
     {name = "Jeremy Retailleau", email = "jeremy.retailleau@gmail.com" }
 ]
 dependencies = [
-    "sphinx >= 1, < 9",
+    "sphinx >= 1, < 10",
 ]
 classifiers = [
     "Intended Audience :: Developers",
@@ -31,6 +31,7 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
 ]
 
 [project.urls]