Script 'mail_helper' called by obssrc
Hello community,
here is the log from the commit of package python-sphinx-autobuild for
openSUSE:Factory checked in at 2025-10-07 18:29:36
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Comparing /work/SRC/openSUSE:Factory/python-sphinx-autobuild (Old)
and /work/SRC/openSUSE:Factory/.python-sphinx-autobuild.new.11973 (New)
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Package is "python-sphinx-autobuild"
Tue Oct 7 18:29:36 2025 rev:6 rq:1309630 version:2025.8.25
Changes:
--------
---
/work/SRC/openSUSE:Factory/python-sphinx-autobuild/python-sphinx-autobuild.changes
2024-11-21 15:15:23.081365468 +0100
+++
/work/SRC/openSUSE:Factory/.python-sphinx-autobuild.new.11973/python-sphinx-autobuild.changes
2025-10-07 18:32:02.490767276 +0200
@@ -1,0 +2,11 @@
+Tue Sep 30 12:13:00 UTC 2025 - Dirk Müller <[email protected]>
+
+- update to 2025.08.25:
+ * Drop support for Python 3.9-3.10 to match Sphinx.
+ * Declare support for Python 3.14.
+ * Add an optional ``--post-build`` flag to run additional commands
+ after building the documentation.
+ * Add support for the ``SPHINX_AUTOBUILD_DEBUG`` environment
+ variable to help with debugging.
+
+-------------------------------------------------------------------
Old:
----
sphinx_autobuild-2024.10.3.tar.gz
New:
----
sphinx_autobuild-2025.8.25.tar.gz
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Other differences:
------------------
++++++ python-sphinx-autobuild.spec ++++++
--- /var/tmp/diff_new_pack.3Ti9F0/_old 2025-10-07 18:32:02.958786996 +0200
+++ /var/tmp/diff_new_pack.3Ti9F0/_new 2025-10-07 18:32:02.958786996 +0200
@@ -1,7 +1,7 @@
#
# spec file for package python-sphinx-autobuild
#
-# Copyright (c) 2024 SUSE LLC
+# Copyright (c) 2025 SUSE LLC and contributors
#
# All modifications and additions to the file contributed by third parties
# remain the property of their copyright owners, unless otherwise agreed
@@ -18,7 +18,7 @@
%{?sle15_python_module_pythons}
Name: python-sphinx-autobuild
-Version: 2024.10.3
+Version: 2025.8.25
Release: 0
Summary: Rebuild Sphinx documentation on changes, with live-reload in
the browser
License: MIT
++++++ sphinx_autobuild-2024.10.3.tar.gz -> sphinx_autobuild-2025.8.25.tar.gz
++++++
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/sphinx_autobuild-2024.10.3/NEWS.rst
new/sphinx_autobuild-2025.8.25/NEWS.rst
--- old/sphinx_autobuild-2024.10.3/NEWS.rst 2024-10-03 01:15:18.386337800
+0200
+++ new/sphinx_autobuild-2025.8.25/NEWS.rst 2025-08-25 20:44:41.925219300
+0200
@@ -4,6 +4,16 @@
unreleased
----------
+2025.08.25 - 2025-08-25
+-----------------------
+
+* Drop support for Python 3.9-3.10 to match Sphinx.
+* Declare support for Python 3.14.
+* Add an optional ``--post-build`` flag to run additional commands
+ after building the documentation.
+* Add support for the ``SPHINX_AUTOBUILD_DEBUG`` environment variable
+ to help with debugging.
+
2024.10.03 - 2024-10-03
-----------------------
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/sphinx_autobuild-2024.10.3/PKG-INFO
new/sphinx_autobuild-2025.8.25/PKG-INFO
--- old/sphinx_autobuild-2024.10.3/PKG-INFO 1970-01-01 01:00:00.000000000
+0100
+++ new/sphinx_autobuild-2025.8.25/PKG-INFO 1970-01-01 01:00:00.000000000
+0100
@@ -1,10 +1,10 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
Name: sphinx-autobuild
-Version: 2024.10.3
+Version: 2025.8.25
Summary: Rebuild Sphinx documentation on changes, with hot reloading in the
browser.
Author: Adam Turner
Author-email: Jonathan Stoppani <[email protected]>
-Requires-Python: >=3.9
+Requires-Python: >=3.11
Description-Content-Type: text/x-rst
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
@@ -14,12 +14,12 @@
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Documentation
@@ -28,8 +28,9 @@
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
+License-File: LICENSE.rst
Requires-Dist: colorama>=0.4.6
-Requires-Dist: sphinx
+Requires-Dist: Sphinx
Requires-Dist: starlette>=0.35
Requires-Dist: uvicorn>=0.25
Requires-Dist: watchfiles>=0.20
@@ -113,6 +114,7 @@
--delay DELAY how long to wait before opening the browser
--watch DIR additional directories to watch
--pre-build COMMAND additional command(s) to run prior to building the
documentation
+ --post-build COMMAND additional command(s) to run after building the
documentation
Using with Makefile
-------------------
@@ -186,6 +188,19 @@
sphinx-autobuild --port=0 --open-browser pikachu/docs
pikachu/docs/_build/html &
sphinx-autobuild --port=0 --open-browser magikarp/docs
magickarp/docs/_build/html &
+Notifications for build cycles
+------------------------------
+
+As an example of using the ``--pre-build`` and ``--post-build`` arguments,
+the command below uses `notify-send` to send a notification when a build
+starts and finishes.
+
+.. code-block:: bash
+
+ sphinx-autobuild docs docs/_build/html/ \
+ --pre-build 'notify-send "sphinx-autobuild: build start"' \
+ --post-build 'notify-send "sphinx-autobuild: build end"'
+
Relevant Sphinx Bugs
====================
@@ -199,6 +214,15 @@
__ https://github.com/sphinx-doc/sphinx-autobuild/issues/34
+Debugging
+=========
+
+If the ``SPHINX_AUTOBUILD_DEBUG`` environment variable is present,
+is not ``""`` (the empty string) or ``0``,
+and a file change is detected,
+its path and the currently active ignore expressions are printed.
+This is to help setting up the ignore expressions correctly.
+
Acknowledgements
================
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/sphinx_autobuild-2024.10.3/README.rst
new/sphinx_autobuild-2025.8.25/README.rst
--- old/sphinx_autobuild-2024.10.3/README.rst 2024-10-03 01:15:18.386337800
+0200
+++ new/sphinx_autobuild-2025.8.25/README.rst 2025-08-25 20:44:41.925219300
+0200
@@ -67,6 +67,7 @@
--delay DELAY how long to wait before opening the browser
--watch DIR additional directories to watch
--pre-build COMMAND additional command(s) to run prior to building the
documentation
+ --post-build COMMAND additional command(s) to run after building the
documentation
Using with Makefile
-------------------
@@ -140,6 +141,19 @@
sphinx-autobuild --port=0 --open-browser pikachu/docs
pikachu/docs/_build/html &
sphinx-autobuild --port=0 --open-browser magikarp/docs
magickarp/docs/_build/html &
+Notifications for build cycles
+------------------------------
+
+As an example of using the ``--pre-build`` and ``--post-build`` arguments,
+the command below uses `notify-send` to send a notification when a build
+starts and finishes.
+
+.. code-block:: bash
+
+ sphinx-autobuild docs docs/_build/html/ \
+ --pre-build 'notify-send "sphinx-autobuild: build start"' \
+ --post-build 'notify-send "sphinx-autobuild: build end"'
+
Relevant Sphinx Bugs
====================
@@ -153,6 +167,15 @@
__ https://github.com/sphinx-doc/sphinx-autobuild/issues/34
+Debugging
+=========
+
+If the ``SPHINX_AUTOBUILD_DEBUG`` environment variable is present,
+is not ``""`` (the empty string) or ``0``,
+and a file change is detected,
+its path and the currently active ignore expressions are printed.
+This is to help setting up the ignore expressions correctly.
+
Acknowledgements
================
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/sphinx_autobuild-2024.10.3/noxfile.py
new/sphinx_autobuild-2025.8.25/noxfile.py
--- old/sphinx_autobuild-2024.10.3/noxfile.py 2024-10-03 01:15:18.387337700
+0200
+++ new/sphinx_autobuild-2025.8.25/noxfile.py 2025-08-25 20:44:41.926219200
+0200
@@ -9,7 +9,7 @@
session.run("pre-commit", "run", "--all-files", *session.posargs)
[email protected](python=["3.9", "3.10", "3.11", "3.12", "3.13"])
[email protected](python=["3.11", "3.12", "3.13", "3.14"])
def test(session):
session.install("-e", ".[test]", silent=True)
session.run("pytest", *session.posargs)
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/sphinx_autobuild-2024.10.3/pyproject.toml
new/sphinx_autobuild-2025.8.25/pyproject.toml
--- old/sphinx_autobuild-2024.10.3/pyproject.toml 2024-10-03
01:15:18.387337700 +0200
+++ new/sphinx_autobuild-2025.8.25/pyproject.toml 2025-08-25
20:44:41.926219200 +0200
@@ -1,76 +1,78 @@
[build-system]
+requires = ["flit-core>=3.7"]
build-backend = "flit_core.buildapi"
-requires = [
- "flit-core>=3.7",
-]
+# project metadata
[project]
name = "sphinx-autobuild"
description = "Rebuild Sphinx documentation on changes, with hot reloading in
the browser."
readme = "README.rst"
+urls.Changelog =
"https://github.com/sphinx-doc/sphinx-autobuild/blob/main/NEWS.rst";
+urls.Documentation = "https://github.com/sphinx-doc/sphinx-autobuild#readme";
+urls.Download = "https://pypi.org/project/sphinx-autobuild/";
+urls."Issue tracker" = "https://github.com/sphinx-doc/sphinx-autobuild/issues";
+urls.Source = "https://github.com/sphinx-doc/sphinx-autobuild";
license.text = "MIT"
-authors = [
- { name = "Adam Turner" },
- { name = "Jonathan Stoppani", email = "[email protected]" },
-]
-requires-python = ">=3.9"
+requires-python = ">=3.11"
+
+# Classifiers list: https://pypi.org/classifiers/
classifiers = [
- "Development Status :: 5 - Production/Stable",
- "Environment :: Console",
- "Environment :: Web Environment",
- "Framework :: Sphinx",
- "Intended Audience :: Developers",
- "License :: OSI Approved :: MIT License",
- "Operating System :: OS Independent",
- "Programming Language :: Python",
- "Programming Language :: Python :: 3 :: Only",
- "Programming Language :: Python :: 3.9",
- "Programming Language :: Python :: 3.10",
- "Programming Language :: Python :: 3.11",
- "Programming Language :: Python :: 3.12",
- "Programming Language :: Python :: 3.13",
- "Programming Language :: Python :: Implementation :: CPython",
- "Programming Language :: Python :: Implementation :: PyPy",
- "Topic :: Documentation",
- "Topic :: Documentation :: Sphinx",
- "Topic :: Software Development",
- "Topic :: Software Development :: Documentation",
- "Topic :: Software Development :: Libraries :: Python Modules",
- "Topic :: Utilities",
-]
-dynamic = [
- "version",
+ "Development Status :: 5 - Production/Stable",
+ "Environment :: Console",
+ "Environment :: Web Environment",
+ "Framework :: Sphinx",
+ "Intended Audience :: Developers",
+ "License :: OSI Approved :: MIT License",
+ "Operating System :: OS Independent",
+ "Programming Language :: Python",
+ "Programming Language :: Python :: 3",
+ "Programming Language :: Python :: 3 :: Only",
+ "Programming Language :: Python :: 3.11",
+ "Programming Language :: Python :: 3.12",
+ "Programming Language :: Python :: 3.13",
+ "Programming Language :: Python :: 3.14",
+ "Programming Language :: Python :: Implementation :: CPython",
+ "Programming Language :: Python :: Implementation :: PyPy",
+ "Topic :: Documentation",
+ "Topic :: Documentation :: Sphinx",
+ "Topic :: Software Development",
+ "Topic :: Software Development :: Documentation",
+ "Topic :: Software Development :: Libraries :: Python Modules",
+ "Topic :: Utilities",
]
dependencies = [
- "colorama>=0.4.6",
- "sphinx",
- "starlette>=0.35",
- "uvicorn>=0.25",
- "watchfiles>=0.20",
- "websockets>=11",
-]
-optional-dependencies.docs = [
+ "colorama>=0.4.6",
+ "Sphinx",
+ "starlette>=0.35",
+ "uvicorn>=0.25",
+ "watchfiles>=0.20",
+ "websockets>=11",
]
-optional-dependencies.test = [
- "httpx",
- "pytest>=6",
+dynamic = ["version"]
+
+[project.optional-dependencies]
+docs = []
+test = [
+ "httpx",
+ "pytest>=6",
]
-urls.Changelog =
"https://github.com/sphinx-doc/sphinx-autobuild/blob/main/NEWS.rst";
-urls.Documentation = "https://github.com/sphinx-doc/sphinx-autobuild#readme";
-urls.Download = "https://pypi.org/project/sphinx-autobuild/";
-urls."Issue tracker" = "https://github.com/sphinx-doc/sphinx-autobuild/issues";
-urls.Source = "https://github.com/sphinx-doc/sphinx-autobuild";
-scripts.sphinx-autobuild = "sphinx_autobuild.__main__:main"
+
+[[project.authors]]
+name = "Adam Turner"
+
+[[project.authors]]
+name = "Jonathan Stoppani"
+email = "[email protected]"
+
+[project.scripts]
+sphinx-autobuild = "sphinx_autobuild.__main__:main"
[tool.flit.sdist]
include = [
- "AUTHORS.rst",
- "LICENSE.rst",
- "NEWS.rst",
- # Tests
- "tests/",
- "noxfile.py",
+ "AUTHORS.rst",
+ "LICENSE.rst",
+ "NEWS.rst",
+ # Tests
+ "tests/",
+ "noxfile.py",
]
-
-[tool.pyproject-fmt]
-max_supported_python = "3.13"
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/sphinx_autobuild-2024.10.3/sphinx_autobuild/__init__.py
new/sphinx_autobuild-2025.8.25/sphinx_autobuild/__init__.py
--- old/sphinx_autobuild-2024.10.3/sphinx_autobuild/__init__.py 2024-10-03
01:15:18.387337700 +0200
+++ new/sphinx_autobuild-2025.8.25/sphinx_autobuild/__init__.py 2025-08-25
20:44:41.927219400 +0200
@@ -1,3 +1,3 @@
"""Rebuild Sphinx documentation on changes, with hot reloading in the
browser."""
-__version__ = "2024.10.03"
+__version__ = "2025.08.25"
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/sphinx_autobuild-2024.10.3/sphinx_autobuild/__main__.py
new/sphinx_autobuild-2025.8.25/sphinx_autobuild/__main__.py
--- old/sphinx_autobuild-2024.10.3/sphinx_autobuild/__main__.py 2024-10-03
01:15:18.388337600 +0200
+++ new/sphinx_autobuild-2025.8.25/sphinx_autobuild/__main__.py 2025-08-25
20:44:41.927219400 +0200
@@ -49,11 +49,12 @@
url_host = f"{host_name}:{port_num}"
pre_build_commands = list(map(shlex.split, args.pre_build))
-
+ post_build_commands = list(map(shlex.split, args.post_build))
builder = Builder(
build_args,
url_host=url_host,
pre_build_commands=pre_build_commands,
+ post_build_commands=post_build_commands,
)
watch_dirs = [src_dir] + args.additional_watched_dirs
@@ -147,6 +148,10 @@
sphinx_build_parser.epilog = None
sphinx_build_parser.prog = "sphinx-autobuild"
for action in sphinx_build_parser._actions:
+ if hasattr(action, "help"):
+ # Replace _TranslationProxy objects with strings
+ action.help = str(action.help)
+ for action in sphinx_build_parser._actions:
if hasattr(action, "version"):
# Fix the version
action.version = f"%(prog)s {__version__}"
@@ -233,6 +238,13 @@
default=[],
help="additional command(s) to run prior to building the
documentation",
)
+ group.add_argument(
+ "--post-build",
+ action="append",
+ metavar="COMMAND",
+ default=[],
+ help="additional command(s) to run after building the documentation",
+ )
return group
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/sphinx_autobuild-2024.10.3/sphinx_autobuild/build.py
new/sphinx_autobuild-2025.8.25/sphinx_autobuild/build.py
--- old/sphinx_autobuild-2024.10.3/sphinx_autobuild/build.py 2024-10-03
01:15:18.388337600 +0200
+++ new/sphinx_autobuild-2025.8.25/sphinx_autobuild/build.py 2025-08-25
20:44:41.927219400 +0200
@@ -15,9 +15,12 @@
class Builder:
- def __init__(self, sphinx_args, *, url_host, pre_build_commands):
+ def __init__(
+ self, sphinx_args, *, url_host, pre_build_commands, post_build_commands
+ ):
self.sphinx_args = sphinx_args
self.pre_build_commands = pre_build_commands
+ self.post_build_commands = post_build_commands
self.uri = f"http://{url_host}";
def __call__(self, *, changed_paths: Sequence[Path]):
@@ -35,24 +38,7 @@
show_message(f"Detected changes ({', '.join(rel_paths)})")
show_message("Rebuilding...")
- try:
- for command in self.pre_build_commands:
- show_message("pre-build")
- show_command(command)
- subprocess.run(command, check=True)
- except subprocess.CalledProcessError as e:
- print(f"Pre-build command exited with exit code: {e.returncode}")
- print(
- "Please fix the cause of the error above or press Ctrl+C to
stop the "
- "server."
- )
- print(
- "The server will continue serving the build folder, but the
contents "
- "being served are no longer in sync with the documentation
sources. "
- "Please fix the cause of the error above or press Ctrl+C to
stop the "
- "server."
- )
- traceback.print_exception(e)
+ if self._run_commands(self.pre_build_commands, "pre-build") != 0:
return
if sphinx.version_info[:3] >= (7, 2, 3):
@@ -70,5 +56,33 @@
"Please fix the cause of the error above or press Ctrl+C to
stop the "
"server."
)
+ else:
+ # Run the post-build commands only if the build was successful
+ self._run_commands(self.post_build_commands, "post-build")
+
# Remind the user of the server URL for convenience.
show_message(f"Serving on {self.uri}")
+
+ def _run_commands(self, commands, log_context):
+ try:
+ for command in commands:
+ show_message(log_context)
+ show_command(command)
+ subprocess.run(command, check=True)
+ except subprocess.CalledProcessError as e:
+ print(
+ f"{log_context.title()} command exited with exit code:
{e.returncode}"
+ )
+ print(
+ "Please fix the cause of the error above or press Ctrl+C to
stop the "
+ "server."
+ )
+ print(
+ "The server will continue serving the build folder, but the
contents "
+ "being served are no longer in sync with the documentation
sources. "
+ "Please fix the cause of the error above or press Ctrl+C to
stop the "
+ "server."
+ )
+ traceback.print_exception(e)
+ return e.returncode
+ return 0
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/sphinx_autobuild-2024.10.3/sphinx_autobuild/filter.py
new/sphinx_autobuild-2025.8.25/sphinx_autobuild/filter.py
--- old/sphinx_autobuild-2024.10.3/sphinx_autobuild/filter.py 2024-10-03
01:15:18.388337600 +0200
+++ new/sphinx_autobuild-2025.8.25/sphinx_autobuild/filter.py 2025-08-25
20:44:41.927219400 +0200
@@ -3,6 +3,7 @@
from __future__ import annotations
import fnmatch
+import os
import re
from pathlib import Path
@@ -23,6 +24,11 @@
def __call__(self, filename: str, /):
"""Determine if 'path' should be ignored."""
normalised_path = Path(filename).resolve().as_posix()
+ if os.getenv("SPHINX_AUTOBUILD_DEBUG") not in {None, "", "0"}:
+ print(
+ f"SPHINX_AUTOBUILD_DEBUG: {normalised_path!r} has changed; "
+ f"ignores are {self}"
+ )
# Any regular pattern matches.
for pattern in self.regular_patterns:
# separators are normalised before creating the IgnoreFilter
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/sphinx_autobuild-2024.10.3/tests/test_application.py
new/sphinx_autobuild-2025.8.25/tests/test_application.py
--- old/sphinx_autobuild-2024.10.3/tests/test_application.py 2024-10-03
01:15:18.388337600 +0200
+++ new/sphinx_autobuild-2025.8.25/tests/test_application.py 2025-08-25
20:44:41.927219400 +0200
@@ -21,7 +21,10 @@
url_host = "127.0.0.1:7777"
ignore_handler = IgnoreFilter([out_dir], [])
builder = Builder(
- [str(src_dir), str(out_dir)], url_host=url_host, pre_build_commands=[]
+ [str(src_dir), str(out_dir)],
+ url_host=url_host,
+ pre_build_commands=[],
+ post_build_commands=[],
)
app = _create_app([src_dir], ignore_handler, builder, out_dir, url_host)
client = TestClient(app)
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/sphinx_autobuild-2024.10.3/tests/test_ignore.py
new/sphinx_autobuild-2025.8.25/tests/test_ignore.py
--- old/sphinx_autobuild-2024.10.3/tests/test_ignore.py 2024-10-03
01:15:18.388337600 +0200
+++ new/sphinx_autobuild-2025.8.25/tests/test_ignore.py 2025-08-25
20:44:41.927219400 +0200
@@ -1,3 +1,7 @@
+import os
+
+import pytest
+
from sphinx_autobuild.filter import IgnoreFilter
@@ -72,3 +76,16 @@
assert ignored("foo/random.txt")
assert ignored("foo/module.pyc")
assert ignored("bar/__pycache__/file.pyc")
+
+
[email protected]("val", [None, "0", "", "y", "1", "whatever"])
+def test_debug(val, capfd):
+ if val is not None:
+ os.environ["SPHINX_AUTOBUILD_DEBUG"] = val
+ ignore_handler = IgnoreFilter([], [])
+ ignore_handler("dummyfile")
+ captured = capfd.readouterr()
+ if val in ("y", "1", "whatever"):
+ assert "SPHINX_AUTOBUILD_DEBUG" in captured.out
+ else:
+ assert "SPHINX_AUTOBUILD_DEBUG" not in captured.out
