From nobody Wed Jan 29 00:08:18 2025 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1734052525; cv=none; d=zohomail.com; s=zohoarc; b=C3XQOle1l6WWHLB3o8/fbT8bBrg1p8xJ1zhYQN+J3rEIcY2uzshlmn4rjgvdvwG39goZJyjxG/NwJp+5D6uaUvJqmqR98s+2RsBgbBM5k6/CDyl2mKeQn+BoBaZjFcjI+/uphvijuMU0TgC45PgD2kHitCerMNAH6+V2zE86/jk= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1734052525; h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=hNB7dl3TSLFCZCtDa8noAbO0oY0hQxHlysvc4+Gdxas=; b=R5/pnBBNolP7xRTkYroM+viATprUxjNBDtdbNOuLb4/bI4rx8AY+u4XoGUI/NXDMgE4cnoI4sPCYel071OKF96+HoTLcEKPSMwvj7GMqRPtZ/m026zjYnsHK0PgToj/CYi4+1u8ZGr7gFKwmi2twWgXWXMPIYysWyTggDVjAZs4= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1734052525483589.894041428637; Thu, 12 Dec 2024 17:15:25 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tLuFa-0005X1-MZ; Thu, 12 Dec 2024 20:13:50 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tLuFZ-0005Wl-3r for qemu-devel@nongnu.org; Thu, 12 Dec 2024 20:13:49 -0500 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tLuFX-00005i-L2 for qemu-devel@nongnu.org; Thu, 12 Dec 2024 20:13:48 -0500 Received: from mx-prod-mc-02.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-314-EdMC53nkPz6D9X3qZ5BD5A-1; Thu, 12 Dec 2024 20:13:40 -0500 Received: from mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.15]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 83C841956046; Fri, 13 Dec 2024 01:13:39 +0000 (UTC) Received: from jsnow-thinkpadp16vgen1.westford.csb (unknown [10.22.88.22]) by mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 7FF6A1956086; Fri, 13 Dec 2024 01:13:35 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1734052426; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=hNB7dl3TSLFCZCtDa8noAbO0oY0hQxHlysvc4+Gdxas=; b=gTDEQhvQKVsoe5hGV8KsSOuxKxyw1CUwlFLfo1dCCYGfzA2xGkDLTv2aDn0itZHDTcIN+W mFAd9XgO1RuCuXp2lhmFhHVuYezesGUKYNZiufdCMrrKx8w9Hd5yiysWVf587ELj635LQj oN7/MVD1cEdeR4RhoSg5kR3BQwjawz4= X-MC-Unique: EdMC53nkPz6D9X3qZ5BD5A-1 X-Mimecast-MFC-AGG-ID: EdMC53nkPz6D9X3qZ5BD5A From: John Snow To: qemu-devel@nongnu.org Cc: Michael Roth , Markus Armbruster , Peter Maydell , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , Victor Toso de Carvalho , Paolo Bonzini , John Snow Subject: [RFC PATCH v2 03/35] docs/sphinx: create QAPI domain extension stub Date: Thu, 12 Dec 2024 20:12:32 -0500 Message-ID: <20241213011307.2942030-4-jsnow@redhat.com> In-Reply-To: <20241213011307.2942030-1-jsnow@redhat.com> References: <20241213011307.2942030-1-jsnow@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.0 on 10.30.177.15 Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=170.10.133.124; envelope-from=jsnow@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -25 X-Spam_score: -2.6 X-Spam_bar: -- X-Spam_report: (-2.6 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.496, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-0.001, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, RCVD_IN_VALIDITY_SAFE_BLOCKED=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1734052527032116600 Content-Type: text/plain; charset="utf-8" It doesn't really do anything yet, we'll get to it brick-by-brick in the forthcoming commits to keep the series breezy and the git history informative. Signed-off-by: John Snow --- docs/conf.py | 9 ++++++- docs/sphinx/qapi-domain.py | 52 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 60 insertions(+), 1 deletion(-) create mode 100644 docs/sphinx/qapi-domain.py diff --git a/docs/conf.py b/docs/conf.py index c11a6ead8a0..f2986ef7d74 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -60,7 +60,14 @@ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions =3D ['kerneldoc', 'qmp_lexer', 'hxtool', 'depfile', 'qapidoc'] +extensions =3D [ + 'depfile', + 'hxtool', + 'kerneldoc', + 'qapi-domain', + 'qapidoc', + 'qmp_lexer', +] =20 if sphinx.version_info[:3] > (4, 0, 0): tags.add('sphinx4') diff --git a/docs/sphinx/qapi-domain.py b/docs/sphinx/qapi-domain.py new file mode 100644 index 00000000000..293cb922861 --- /dev/null +++ b/docs/sphinx/qapi-domain.py @@ -0,0 +1,52 @@ +""" +QAPI domain extension. +""" + +from __future__ import annotations + +from typing import ( + TYPE_CHECKING, + Any, + Dict, + List, + Tuple, +) + +from sphinx.domains import Domain, ObjType +from sphinx.util import logging + + +if TYPE_CHECKING: + from sphinx.application import Sphinx + +logger =3D logging.getLogger(__name__) + + +class QAPIDomain(Domain): + """QAPI language domain.""" + + name =3D "qapi" + label =3D "QAPI" + + object_types: Dict[str, ObjType] =3D {} + directives =3D {} + roles =3D {} + initial_data: Dict[str, Dict[str, Tuple[Any]]] =3D {} + indices =3D [] + + def merge_domaindata( + self, docnames: List[str], otherdata: Dict[str, Any] + ) -> None: + pass + + +def setup(app: Sphinx) -> Dict[str, Any]: + app.setup_extension("sphinx.directives") + app.add_domain(QAPIDomain) + + return { + "version": "1.0", + "env_version": 1, + "parallel_read_safe": True, + "parallel_write_safe": True, + } --=20 2.47.0