All of lore.kernel.org
 help / color / mirror / Atom feed
From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Alex Bennée" <alex.bennee@linaro.org>,
	"Cleber Rosa" <crosa@redhat.com>,
	"Kohei Tokunaga" <ktokunaga.mail@gmail.com>,
	"Peter Maydell" <peter.maydell@linaro.org>,
	"Philippe Mathieu-Daudé" <philmd@mailo.com>,
	"John Snow" <jsnow@redhat.com>,
	"Paolo Bonzini" <pbonzini@redhat.com>,
	"Mauro Carvalho Chehab" <mchehab+huawei@kernel.org>,
	"Warner Losh" <imp@bsdimp.com>,
	"Marc-André Lureau" <marcandre.lureau@redhat.com>,
	"Pierrick Bouvier" <pierrick.bouvier@oss.qualcomm.com>,
	"Michael Roth" <michael.roth@amd.com>,
	"Reinoud Zandijk" <reinoud@netbsd.org>,
	"Kyle Evans" <kevans@freebsd.org>,
	"Markus Armbruster" <armbru@redhat.com>
Subject: [PATCH v3 15/16] sphinx: drop fakedbusdoc
Date: Tue, 25 Aug 2026 17:58:50 -0400	[thread overview]
Message-ID: <20260825215851.1780608-16-jsnow@redhat.com> (raw)
In-Reply-To: <20260825215851.1780608-1-jsnow@redhat.com>

Now that we rely on a sufficiently modern Sphinx, we no longer need a
stub doc for dbus.

Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
---
 docs/conf.py                  |  7 +------
 docs/interop/dbus-display.rst | 14 +-------------
 docs/interop/dbus-vmstate.rst | 14 +-------------
 docs/interop/dbus-vnc.rst     | 14 +-------------
 docs/sphinx/fakedbusdoc.py    | 30 ------------------------------
 5 files changed, 4 insertions(+), 75 deletions(-)
 delete mode 100644 docs/sphinx/fakedbusdoc.py

diff --git a/docs/conf.py b/docs/conf.py
index cded047b539..914bae67d9c 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -59,6 +59,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    'dbusdoc',
     'depfile',
     'hxtool',
     'kerneldoc',
@@ -67,12 +68,6 @@
     'qmp_lexer',
 ]
 
-if sphinx.version_info[:3] > (4, 0, 0):
-    tags.add('sphinx4')
-    extensions += ['dbusdoc']
-else:
-    extensions += ['fakedbusdoc']
-
 # Add any paths that contain templates here, relative to this directory.
 templates_path = [os.path.join(qemu_docdir, '_templates')]
 
diff --git a/docs/interop/dbus-display.rst b/docs/interop/dbus-display.rst
index 87648e91dc0..c87a04c9693 100644
--- a/docs/interop/dbus-display.rst
+++ b/docs/interop/dbus-display.rst
@@ -18,16 +18,4 @@ QEMU also implements the standard interfaces, such as
    :local:
    :depth: 1
 
-.. only:: sphinx4
-
-   .. dbus-doc:: ui/dbus-display1.xml
-
-.. only:: not sphinx4
-
-   .. warning::
-      Sphinx 4 is required to build D-Bus documentation.
-
-      This is the content of ``ui/dbus-display1.xml``:
-
-   .. literalinclude:: ../../ui/dbus-display1.xml
-      :language: xml
+.. dbus-doc:: ui/dbus-display1.xml
diff --git a/docs/interop/dbus-vmstate.rst b/docs/interop/dbus-vmstate.rst
index 5fb3f279e28..5f8c6d125de 100644
--- a/docs/interop/dbus-vmstate.rst
+++ b/docs/interop/dbus-vmstate.rst
@@ -23,16 +23,4 @@ dbus-vmstate object can be configured with the expected list of
 helpers by setting its ``id-list`` property, with a comma-separated
 ``Id`` list.
 
-.. only:: sphinx4
-
-   .. dbus-doc:: backends/dbus-vmstate1.xml
-
-.. only:: not sphinx4
-
-   .. warning::
-      Sphinx 4 is required to build D-Bus documentation.
-
-      This is the content of ``backends/dbus-vmstate1.xml``:
-
-   .. literalinclude:: ../../backends/dbus-vmstate1.xml
-      :language: xml
+.. dbus-doc:: backends/dbus-vmstate1.xml
diff --git a/docs/interop/dbus-vnc.rst b/docs/interop/dbus-vnc.rst
index d2b77978f63..5ea4fd57183 100644
--- a/docs/interop/dbus-vnc.rst
+++ b/docs/interop/dbus-vnc.rst
@@ -11,16 +11,4 @@ Objects are exported under ``/org/qemu/Vnc1/``.
    :local:
    :depth: 1
 
-.. only:: sphinx4
-
-   .. dbus-doc:: tools/qemu-vnc/qemu-vnc1.xml
-
-.. only:: not sphinx4
-
-   .. warning::
-      Sphinx 4 is required to build D-Bus documentation.
-
-      This is the content of ``tools/qemu-vnc/qemu-vnc1.xml``:
-
-   .. literalinclude:: ../../tools/qemu-vnc/qemu-vnc1.xml
-      :language: xml
+.. dbus-doc:: tools/qemu-vnc/qemu-vnc1.xml
diff --git a/docs/sphinx/fakedbusdoc.py b/docs/sphinx/fakedbusdoc.py
deleted file mode 100644
index 2d2e6ef6403..00000000000
--- a/docs/sphinx/fakedbusdoc.py
+++ /dev/null
@@ -1,30 +0,0 @@
-# D-Bus XML documentation extension, compatibility gunk for <sphinx4
-#
-# Copyright (C) 2021, Red Hat Inc.
-#
-# SPDX-License-Identifier: LGPL-2.1-or-later
-#
-# Author: Marc-André Lureau <marcandre.lureau@redhat.com>
-"""dbus-doc is a Sphinx extension that provides documentation from D-Bus XML."""
-
-from docutils.parsers.rst import Directive
-from sphinx.application import Sphinx
-from typing import Any, Dict
-
-
-class FakeDBusDocDirective(Directive):
-    has_content = True
-    required_arguments = 1
-
-    def run(self):
-        return []
-
-
-def setup(app: Sphinx) -> Dict[str, Any]:
-    """Register a fake dbus-doc directive with Sphinx"""
-    app.add_directive("dbus-doc", FakeDBusDocDirective)
-
-    return dict(
-        parallel_read_safe = True,
-        parallel_write_safe = True
-    )
-- 
2.55.0



  parent reply	other threads:[~2026-08-25 22:00 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-08-25 21:58 [PATCH v3 00/16] python: require python3.12+ John Snow
2026-08-25 21:58 ` [PATCH v3 01/16] tests: update vm tests to prefer locally-built QEMU John Snow
2026-08-25 21:58 ` [PATCH v3 02/16] tests: update libvirt-ci, lcitool John Snow
2026-08-26  8:35   ` Daniel P. Berrangé
2026-08-25 21:58 ` [PATCH v3 03/16] tests: update netbsd dependencies John Snow
2026-08-25 21:58 ` [PATCH v3 04/16] tests: drop python3-devel mapping John Snow
2026-08-25 21:58 ` [PATCH v3 05/16] tests: re-add opencv2 and numpy dependencies John Snow
2026-08-25 21:58 ` [PATCH v3 06/16] tests: add Python3.12 to centos9.docker John Snow
2026-08-25 21:58 ` [PATCH v3 07/16] tests: update emsdk-wasm64-cross John Snow
2026-08-25 21:58 ` [PATCH v3 08/16] qapi: update type hint for objects_seen John Snow
2026-08-25 21:58 ` [PATCH v3 09/16] python: upgrade to Python3.12+ John Snow
2026-08-25 21:58 ` [PATCH v3 10/16] python: fix license configuration John Snow
2026-08-25 21:58 ` [PATCH v3 11/16] python: allow mypy to run as the current python version John Snow
2026-08-25 21:58 ` [PATCH v3 12/16] python: remove distutils workarounds John Snow
2026-08-25 21:58 ` [PATCH v3 13/16] python: remove stale setup.cfg options John Snow
2026-08-25 21:58 ` [PATCH v3 14/16] sphinx: require sphinx 7.2.6 John Snow
2026-08-25 21:58 ` John Snow [this message]
2026-08-25 21:58 ` [PATCH v3 16/16] sphinx: drop qapidoc back-compat overboiled spaghetti dinner John Snow

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260825215851.1780608-16-jsnow@redhat.com \
    --to=jsnow@redhat.com \
    --cc=alex.bennee@linaro.org \
    --cc=armbru@redhat.com \
    --cc=crosa@redhat.com \
    --cc=imp@bsdimp.com \
    --cc=kevans@freebsd.org \
    --cc=ktokunaga.mail@gmail.com \
    --cc=marcandre.lureau@redhat.com \
    --cc=mchehab+huawei@kernel.org \
    --cc=michael.roth@amd.com \
    --cc=pbonzini@redhat.com \
    --cc=peter.maydell@linaro.org \
    --cc=philmd@mailo.com \
    --cc=pierrick.bouvier@oss.qualcomm.com \
    --cc=qemu-devel@nongnu.org \
    --cc=reinoud@netbsd.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.