From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Mads Ynddal" <mads@ynddal.dk>, "Jiri Pirko" <jiri@resnulli.us>,
"Stefan Hajnoczi" <stefanha@redhat.com>,
"Eric Blake" <eblake@redhat.com>,
"Peter Maydell" <peter.maydell@linaro.org>,
"Michael Roth" <michael.roth@amd.com>,
"Michael S. Tsirkin" <mst@redhat.com>,
"Alex Williamson" <alex.williamson@redhat.com>,
"Pavel Dovgalyuk" <pavel.dovgaluk@ispras.ru>,
"Victor Toso de Carvalho" <victortoso@redhat.com>,
"Cédric Le Goater" <clg@redhat.com>,
"Daniel P. Berrangé" <berrange@redhat.com>,
qemu-block@nongnu.org, "Ani Sinha" <anisinha@redhat.com>,
"Fabiano Rosas" <farosas@suse.de>,
"Marcel Apfelbaum" <marcel.apfelbaum@gmail.com>,
"Marc-André Lureau" <marcandre.lureau@redhat.com>,
"Gerd Hoffmann" <kraxel@redhat.com>,
"Paolo Bonzini" <pbonzini@redhat.com>,
"Kevin Wolf" <kwolf@redhat.com>, "Peter Xu" <peterx@redhat.com>,
"Eduardo Habkost" <eduardo@habkost.net>,
"Markus Armbruster" <armbru@redhat.com>,
"Philippe Mathieu-Daudé" <philmd@linaro.org>,
"Lukas Straub" <lukasstraub2@web.de>,
"Igor Mammedov" <imammedo@redhat.com>,
"Jason Wang" <jasowang@redhat.com>,
"Yanan Wang" <wangyanan55@huawei.com>,
"Hanna Reitz" <hreitz@redhat.com>,
"Konstantin Kostiuk" <kkostiuk@redhat.com>,
"Stefan Berger" <stefanb@linux.vnet.ibm.com>,
"Harmonie Snow" <harmonie@gmail.com>,
"John Snow" <jsnow@redhat.com>
Subject: [PATCH v2 17/21] docs/sphinx: add CSS styling for qmp-example directive
Date: Wed, 26 Jun 2024 18:21:23 -0400 [thread overview]
Message-ID: <20240626222128.406106-18-jsnow@redhat.com> (raw)
In-Reply-To: <20240626222128.406106-1-jsnow@redhat.com>
From: Harmonie Snow <harmonie@gmail.com>
Add CSS styling for qmp-example directives to increase readability and
consistently style all example blocks.
Signed-off-by: Harmonie Snow <harmonie@gmail.com>
Signed-off-by: John Snow <jsnow@redhat.com>
---
docs/sphinx-static/theme_overrides.css | 46 ++++++++++++++++++++++++++
1 file changed, 46 insertions(+)
diff --git a/docs/sphinx-static/theme_overrides.css b/docs/sphinx-static/theme_overrides.css
index c70ef951286..f3223af62b2 100644
--- a/docs/sphinx-static/theme_overrides.css
+++ b/docs/sphinx-static/theme_overrides.css
@@ -87,6 +87,52 @@ div[class^="highlight"] pre {
padding-bottom: 1px;
}
+/* qmp-example directive styling */
+
+.rst-content .admonition-example {
+ background-color: #fcfcfc;
+ padding: 0px;
+}
+
+.rst-content .admonition-example > .admonition-title {
+ background-color: #338254;
+ margin: 0px;
+}
+
+.rst-content .admonition-example > div[class^=highlight] {
+ border-top: 1px solid #d7f0d7;
+ border-bottom: 1px solid #d7f0d7;
+ border-left: 3px solid #d7f0d7;
+ border-right: 3px solid #d7f0d7;
+}
+
+.rst-content .admonition-example .highlight {
+ background: linear-gradient(#d9f1d9 1%, #ecf8ec 10%,
+ #ecf8ec 90%, #d9f1d9 99%);
+}
+
+.rst-content .admonition-example > .admonition-title:before {
+ content: "🧩";
+}
+
+.rst-content .admonition-example > .admonition-title p {
+ margin: 0px;
+}
+
+.rst-content .admonition-example p {
+ padding: 15px 10px;
+ margin: 0px;
+ background-color: #fafafa;
+ border-left: 1px solid #ededed;
+ border-right: 1px solid #ededed;
+}
+
+.rst-content .admonition-example > .admonition {
+ background-color: #fcfcfc;
+}
+
+/* end qmp-example styling */
+
@media screen {
/* content column
--
2.45.0
next prev parent reply other threads:[~2024-06-26 22:24 UTC|newest]
Thread overview: 44+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-06-26 22:21 [PATCH v2 00/21] qapi: convert "Note" and "Example" sections to rST John Snow
2024-06-26 22:21 ` [PATCH v2 01/21] [DO-NOT-MERGE]: Add some ad-hoc linting helpers John Snow
2024-06-26 22:21 ` [PATCH v2 02/21] qapi: linter fixups John Snow
2024-06-26 22:21 ` [PATCH v2 03/21] docs/qapidoc: remove unused intersperse function John Snow
2024-06-27 6:02 ` Markus Armbruster
2024-06-27 6:12 ` John Snow
2024-06-27 10:46 ` Markus Armbruster
2024-06-27 10:43 ` Markus Armbruster
2024-06-26 22:21 ` [PATCH v2 04/21] docs/qapidoc: delint a tiny portion of the module John Snow
2024-06-28 7:29 ` Markus Armbruster
2024-06-28 14:36 ` John Snow
2024-06-26 22:21 ` [PATCH v2 05/21] qapi/parser: preserve indentation in QAPIDoc sections John Snow
2024-06-27 6:25 ` Markus Armbruster
2024-06-27 6:35 ` John Snow
2024-06-27 10:46 ` Markus Armbruster
2024-06-27 10:43 ` Markus Armbruster
2024-06-26 22:21 ` [PATCH v2 06/21] qapi/parser: fix comment parsing immediately following a doc block John Snow
2024-06-26 22:21 ` [PATCH v2 07/21] docs/qapidoc: fix nested parsing under untagged sections John Snow
2024-06-28 7:54 ` Markus Armbruster
2024-06-28 15:10 ` John Snow
2024-06-28 15:28 ` John Snow
2024-07-01 9:11 ` Markus Armbruster
2024-06-26 22:21 ` [PATCH v2 08/21] qapi: fix non-compliant JSON examples John Snow
2024-06-26 22:21 ` [PATCH v2 09/21] qapi: nail down convention that Errors sections are lists John Snow
2024-06-26 22:21 ` [PATCH v2 10/21] qapi: convert "Note" sections to plain rST John Snow
2024-06-28 9:51 ` Markus Armbruster
2024-06-28 15:44 ` John Snow
2024-07-01 15:08 ` Markus Armbruster
2024-06-26 22:21 ` [PATCH v2 11/21] qapi: update prose in note blocks John Snow
2024-06-26 22:21 ` [PATCH v2 12/21] qapi: add markup to " John Snow
2024-06-26 22:21 ` [PATCH v2 13/21] qapi/parser: don't parse rST markup as section headers John Snow
2024-06-27 7:47 ` Markus Armbruster
2024-06-26 22:21 ` [PATCH v2 14/21] docs/qapidoc: factor out do_parse() John Snow
2024-06-28 13:08 ` Markus Armbruster
2024-06-28 15:16 ` John Snow
2024-06-26 22:21 ` [PATCH v2 15/21] docs/qapidoc: create qmp-example directive John Snow
2024-06-28 13:24 ` Markus Armbruster
2024-06-28 15:24 ` John Snow
2024-06-26 22:21 ` [PATCH v2 16/21] docs/qapidoc: add QMP highlighting to annotated qmp-example blocks John Snow
2024-06-26 22:21 ` John Snow [this message]
2024-06-26 22:21 ` [PATCH v2 18/21] qapi: convert "Example" sections without titles John Snow
2024-06-26 22:21 ` [PATCH v2 19/21] qapi: convert "Example" sections with titles John Snow
2024-06-26 22:21 ` [PATCH v2 20/21] qapi: convert "Example" sections with longer prose John Snow
2024-06-26 22:21 ` [PATCH v2 21/21] qapi: remove "Example" doc section 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=20240626222128.406106-18-jsnow@redhat.com \
--to=jsnow@redhat.com \
--cc=alex.williamson@redhat.com \
--cc=anisinha@redhat.com \
--cc=armbru@redhat.com \
--cc=berrange@redhat.com \
--cc=clg@redhat.com \
--cc=eblake@redhat.com \
--cc=eduardo@habkost.net \
--cc=farosas@suse.de \
--cc=harmonie@gmail.com \
--cc=hreitz@redhat.com \
--cc=imammedo@redhat.com \
--cc=jasowang@redhat.com \
--cc=jiri@resnulli.us \
--cc=kkostiuk@redhat.com \
--cc=kraxel@redhat.com \
--cc=kwolf@redhat.com \
--cc=lukasstraub2@web.de \
--cc=mads@ynddal.dk \
--cc=marcandre.lureau@redhat.com \
--cc=marcel.apfelbaum@gmail.com \
--cc=michael.roth@amd.com \
--cc=mst@redhat.com \
--cc=pavel.dovgaluk@ispras.ru \
--cc=pbonzini@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=peterx@redhat.com \
--cc=philmd@linaro.org \
--cc=qemu-block@nongnu.org \
--cc=qemu-devel@nongnu.org \
--cc=stefanb@linux.vnet.ibm.com \
--cc=stefanha@redhat.com \
--cc=victortoso@redhat.com \
--cc=wangyanan55@huawei.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).