docs/qapi-domain: add :deprecated: directive option

Although "deprecated" is a feature (and *will* appear in the features
list), add a special :deprecated: option to generate an eye-catch that
makes this information very hard to miss.

The forthcoming Transmogrifier in qapidoc.py will add this option
whenever it detects that the features list attached to a definition
contains the "deprecated" entry.

P.S., I outsourced the CSS ;)

Signed-off-by: Harmonie Snow <harmonie@gmail.com>
Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20250311034303.75779-24-jsnow@redhat.com>
Acked-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
This commit is contained in:
John Snow 2025-03-10 23:42:21 -04:00 committed by Markus Armbruster
parent 3fe3349d23
commit 1a0c090a5b
2 changed files with 51 additions and 0 deletions

View file

@ -208,3 +208,28 @@ div[class^="highlight"] pre {
color: inherit;
}
}
/* QAPI domain theming */
.qapi-infopips {
margin-bottom: 1em;
}
.qapi-infopip {
display: inline-block;
padding: 0em 0.5em 0em 0.5em;
margin: 0.25em;
}
.qapi-deprecated {
background-color: #fffef5;
border: solid #fff176 6px;
font-weight: bold;
padding: 8px;
border-radius: 15px;
margin: 5px;
}
.qapi-deprecated::before {
content: '⚠️ ';
}