From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Michael Roth" <michael.roth@amd.com>,
"Alex Bennée" <alex.bennee@linaro.org>,
"Philippe Mathieu-Daudé" <philmd@linaro.org>,
"Peter Maydell" <peter.maydell@linaro.org>,
"Thomas Huth" <thuth@redhat.com>,
"Daniel P. Berrangé" <berrange@redhat.com>,
"Markus Armbruster" <armbru@redhat.com>,
"John Snow" <jsnow@redhat.com>
Subject: [PATCH 14/57] docs/qapi-domain: add "Features:" field lists
Date: Tue, 4 Mar 2025 22:45:23 -0500 [thread overview]
Message-ID: <20250305034610.960147-15-jsnow@redhat.com> (raw)
In-Reply-To: <20250305034610.960147-1-jsnow@redhat.com>
Add support for Features field lists. There is no QAPI-specific
functionality here, but this could be changed if desired (if we wanted
the feature names to link somewhere, for instance.)
This feature list doesn't have any restrictions, so it can be used to
document object-wide features or per-member features as deemed
appropriate. It's essentially free-form text.
Signed-off-by: John Snow <jsnow@redhat.com>
---
docs/sphinx/qapi_domain.py | 12 +++++++++++-
1 file changed, 11 insertions(+), 1 deletion(-)
diff --git a/docs/sphinx/qapi_domain.py b/docs/sphinx/qapi_domain.py
index 64b540ff940..e1b766d9481 100644
--- a/docs/sphinx/qapi_domain.py
+++ b/docs/sphinx/qapi_domain.py
@@ -35,7 +35,7 @@
from sphinx.locale import _, __
from sphinx.roles import XRefRole
from sphinx.util import logging
-from sphinx.util.docfields import TypedField
+from sphinx.util.docfields import GroupedField, TypedField
from sphinx.util.docutils import SphinxDirective
from sphinx.util.nodes import make_id, make_refnode
@@ -143,6 +143,16 @@ class QAPIObject(ObjectDescription[Signature]):
}
)
+ doc_field_types = [
+ # :feat name: descr
+ GroupedField(
+ "feature",
+ label=_("Features"),
+ names=("feat",),
+ can_collapse=False,
+ ),
+ ]
+
def get_signature_prefix(self) -> List[nodes.Node]:
"""Returns a prefix to put before the object name in the signature."""
assert self.objtype
--
2.48.1
next prev parent reply other threads:[~2025-03-05 3:47 UTC|newest]
Thread overview: 129+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-03-05 3:45 [PATCH 00/57] docs: Add new QAPI transmogrifier John Snow
2025-03-05 3:45 ` [PATCH 01/57] do-not-merge John Snow
2025-03-05 3:45 ` [PATCH 02/57] qapi: shush pylint up John Snow
2025-03-05 6:28 ` Markus Armbruster
2025-03-05 15:31 ` John Snow
2025-03-05 3:45 ` [PATCH 03/57] docs/sphinx: create QAPI domain extension stub John Snow
2025-03-05 3:45 ` [PATCH 04/57] docs/sphinx: add compat.py module and nested_parse helper John Snow
2025-03-07 5:46 ` Markus Armbruster
2025-03-07 20:08 ` John Snow
2025-03-05 3:45 ` [PATCH 05/57] docs/qapi-domain: add qapi:module directive John Snow
2025-03-05 3:45 ` [PATCH 06/57] docs/qapi-domain: add QAPI domain object registry John Snow
2025-03-05 3:45 ` [PATCH 07/57] docs/qapi-domain: add QAPI index John Snow
2025-03-05 3:45 ` [PATCH 08/57] docs/qapi-domain: add resolve_any_xref() John Snow
2025-03-05 3:45 ` [PATCH 09/57] docs/qapi-domain: add QAPI xref roles John Snow
2025-03-07 10:08 ` Markus Armbruster
2025-03-07 21:23 ` John Snow
2025-03-05 3:45 ` [PATCH 10/57] docs/qapi-domain: add compatibility node classes John Snow
2025-03-05 3:45 ` [PATCH 11/57] docs/qapi-domain: add qapi:command directive John Snow
2025-03-07 6:33 ` Markus Armbruster
2025-03-07 22:39 ` John Snow
2025-03-05 3:45 ` [PATCH 12/57] docs/qapi-domain: add :since: directive option John Snow
2025-03-07 6:59 ` Markus Armbruster
2025-03-07 22:43 ` John Snow
2025-03-05 3:45 ` [PATCH 13/57] docs/qapi-domain: add "Arguments:" field lists John Snow
2025-03-07 7:46 ` Markus Armbruster
2025-03-07 22:48 ` John Snow
2025-03-05 3:45 ` John Snow [this message]
2025-03-05 3:45 ` [PATCH 15/57] docs/qapi-domain: add "Errors:" " John Snow
2025-03-07 7:48 ` Markus Armbruster
2025-03-07 22:50 ` John Snow
2025-03-08 6:49 ` Markus Armbruster
2025-03-05 3:45 ` [PATCH 16/57] docs/qapi-domain: add "Returns:" " John Snow
2025-03-07 7:58 ` Markus Armbruster
2025-03-07 22:58 ` John Snow
2025-03-08 6:57 ` Markus Armbruster
2025-03-05 3:45 ` [PATCH 17/57] docs/qapi-domain: add qapi:enum directive John Snow
2025-03-05 3:45 ` [PATCH 18/57] docs/qapi-domain: add qapi:alternate directive John Snow
2025-03-07 10:18 ` Markus Armbruster
2025-03-07 23:02 ` John Snow
2025-03-08 6:58 ` Markus Armbruster
2025-03-05 3:45 ` [PATCH 19/57] docs/qapi-domain: add qapi:event directive John Snow
2025-03-07 10:26 ` Markus Armbruster
2025-03-07 23:06 ` John Snow
2025-03-08 7:00 ` Markus Armbruster
2025-03-05 3:45 ` [PATCH 20/57] docs/qapi-domain: add qapi:object directive John Snow
2025-03-05 3:45 ` [PATCH 21/57] docs/qapi-domain: add :deprecated: directive option John Snow
2025-03-05 9:13 ` Markus Armbruster
2025-03-05 15:34 ` John Snow
2025-03-06 7:22 ` Markus Armbruster
2025-03-07 10:47 ` Markus Armbruster
2025-03-08 18:24 ` John Snow
2025-03-05 3:45 ` [PATCH 22/57] docs/qapi-domain: add :unstable: " John Snow
2025-03-05 3:45 ` [PATCH 23/57] docs/qapi-domain: add :ifcond: " John Snow
2025-03-07 10:57 ` Markus Armbruster
2025-03-05 3:45 ` [PATCH 24/57] docs/qapi-domain: add warnings for malformed field lists John Snow
2025-03-05 3:45 ` [PATCH 25/57] docs/qapi-domain: add type cross-refs to " John Snow
2025-03-05 3:45 ` [PATCH 26/57] docs/qapi-domain: add CSS styling John Snow
2025-03-05 3:45 ` [PATCH 27/57] docs/qapi-domain: add XREF compatibility goop for Sphinx < 4.1 John Snow
2025-03-05 3:45 ` [PATCH 28/57] docs/qapi-domain: warn when QAPI domain xrefs fail to resolve John Snow
2025-03-05 3:45 ` [PATCH 29/57] docs/qapi-domain: Fix error context reporting in Sphinx 5.x and 6.x John Snow
2025-03-05 3:45 ` [PATCH 30/57] qapi/parser: adjust info location for doc body section John Snow
2025-03-05 10:10 ` Markus Armbruster
2025-03-06 3:42 ` John Snow
2025-03-06 6:53 ` Markus Armbruster
2025-03-05 3:45 ` [PATCH 31/57] qapi: expand tags to all doc sections John Snow
2025-03-05 10:16 ` Markus Armbruster
2025-03-06 3:58 ` John Snow
2025-03-06 7:42 ` Markus Armbruster
2025-03-05 3:45 ` [PATCH 32/57] qapi/schema: add __repr__ to QAPIDoc.Section John Snow
2025-03-05 3:45 ` [PATCH 33/57] docs/qapidoc: add transmogrifier stub John Snow
2025-03-05 3:45 ` [PATCH 34/57] docs/qapidoc: split old implementation into qapidoc_legacy.py John Snow
2025-03-05 3:45 ` [PATCH 35/57] docs/qapidoc: Fix static typing on qapidoc.py John Snow
2025-03-07 11:59 ` Markus Armbruster
2025-03-08 18:32 ` John Snow
2025-03-09 5:37 ` Markus Armbruster
2025-03-09 6:46 ` John Snow
2025-03-05 3:45 ` [PATCH 36/57] do-not-merge John Snow
2025-03-05 3:45 ` [PATCH 37/57] docs/qapidoc: add transmogrifier class stub John Snow
2025-03-05 3:45 ` [PATCH 38/57] docs/qapidoc: add visit_module() method John Snow
2025-03-05 3:45 ` [PATCH 39/57] qapi/source: allow multi-line QAPISourceInfo advancing John Snow
2025-03-05 10:35 ` Markus Armbruster
2025-03-06 3:13 ` John Snow
2025-03-06 7:01 ` Markus Armbruster
2025-03-05 3:45 ` [PATCH 40/57] docs/qapidoc: add visit_freeform() method John Snow
2025-03-07 12:10 ` Markus Armbruster
2025-03-08 8:02 ` John Snow
2025-03-05 3:45 ` [PATCH 41/57] docs/qapidoc: add preamble() method John Snow
2025-03-07 12:13 ` Markus Armbruster
2025-03-08 8:03 ` John Snow
2025-03-05 3:45 ` [PATCH 42/57] docs/qapidoc: add visit_paragraph() method John Snow
2025-03-05 3:45 ` [PATCH 43/57] docs/qapidoc: add visit_errors() method John Snow
2025-03-07 12:14 ` Markus Armbruster
2025-03-05 3:45 ` [PATCH 44/57] docs/qapidoc: add format_type() method John Snow
2025-03-05 3:45 ` [PATCH 45/57] docs/qapidoc: add add_field() and generate_field() helper methods John Snow
2025-03-05 3:45 ` [PATCH 46/57] docs/qapidoc: add visit_feature() method John Snow
2025-03-07 12:16 ` Markus Armbruster
2025-03-05 3:45 ` [PATCH 47/57] docs/qapidoc: prepare to record entity being transmogrified John Snow
2025-03-05 3:45 ` [PATCH 48/57] docs/qapidoc: add visit_returns() method John Snow
2025-03-07 12:18 ` Markus Armbruster
2025-03-08 8:06 ` John Snow
2025-03-05 3:45 ` [PATCH 49/57] docs/qapidoc: add visit_member() method John Snow
2025-03-07 12:24 ` Markus Armbruster
2025-03-08 8:07 ` John Snow
2025-03-05 3:45 ` [PATCH 50/57] docs/qapidoc: add visit_sections() method John Snow
2025-03-07 12:25 ` Markus Armbruster
2025-03-08 8:10 ` John Snow
2025-03-08 9:20 ` Markus Armbruster
2025-03-05 3:46 ` [PATCH 51/57] docs/qapidoc: add visit_entity() John Snow
2025-03-07 12:26 ` Markus Armbruster
2025-03-08 8:12 ` John Snow
2025-03-05 3:46 ` [PATCH 52/57] docs/qapidoc: implement transmogrify() method John Snow
2025-03-05 3:46 ` [PATCH 53/57] docs: disambiguate cross-references John Snow
2025-03-05 3:46 ` [PATCH 54/57] docs/qapidoc: add transmogrifier test document John Snow
2025-03-09 7:19 ` Markus Armbruster
2025-03-05 3:46 ` [PATCH 55/57] docs/qapidoc: process @foo into ``foo`` John Snow
2025-03-05 3:46 ` [PATCH 56/57] docs/qapidoc: add intermediate output debugger John Snow
2025-03-07 12:34 ` Markus Armbruster
2025-03-08 8:13 ` John Snow
2025-03-08 9:21 ` Markus Armbruster
2025-03-05 3:46 ` [PATCH 57/57] docs/qapidoc: Add "the members of" pointers John Snow
2025-03-07 12:37 ` Markus Armbruster
2025-03-08 8:18 ` John Snow
2025-03-05 11:31 ` [PATCH 00/57] docs: Add new QAPI transmogrifier Markus Armbruster
2025-03-05 15:40 ` John Snow
2025-03-06 7:19 ` Markus Armbruster
2025-03-06 10:58 ` Markus Armbruster
2025-03-06 12:35 ` Markus Armbruster
2025-03-06 13:27 ` John Snow
2025-03-07 18:19 ` Markus Armbruster
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=20250305034610.960147-15-jsnow@redhat.com \
--to=jsnow@redhat.com \
--cc=alex.bennee@linaro.org \
--cc=armbru@redhat.com \
--cc=berrange@redhat.com \
--cc=michael.roth@amd.com \
--cc=peter.maydell@linaro.org \
--cc=philmd@linaro.org \
--cc=qemu-devel@nongnu.org \
--cc=thuth@redhat.com \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).