[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v2 5/9] docs/sphinx: add CSS styling for qmp-example directive
From: |
John Snow |
Subject: |
[PATCH v2 5/9] docs/sphinx: add CSS styling for qmp-example directive |
Date: |
Tue, 16 Jul 2024 22:13:07 -0400 |
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>
Acked-by: Markus Armbruster <armbru@redhat.com>
---
docs/sphinx-static/theme_overrides.css | 49 ++++++++++++++++++++++++++
1 file changed, 49 insertions(+)
diff --git a/docs/sphinx-static/theme_overrides.css
b/docs/sphinx-static/theme_overrides.css
index c70ef951286..965ecac54fd 100644
--- a/docs/sphinx-static/theme_overrides.css
+++ b/docs/sphinx-static/theme_overrides.css
@@ -87,6 +87,55 @@ div[class^="highlight"] pre {
padding-bottom: 1px;
}
+/* qmp-example directive styling */
+
+.rst-content .admonition-example {
+ /* do not apply the standard admonition background */
+ background-color: transparent;
+ border: solid #ffd2ed 1px;
+}
+
+.rst-content .admonition-example > .admonition-title:before {
+ content: "▷";
+}
+
+.rst-content .admonition-example > .admonition-title {
+ background-color: #5980a6;
+}
+
+.rst-content .admonition-example > div[class^="highlight"] {
+ /* make code boxes take up the full width of the admonition w/o margin */
+ margin-left: -12px;
+ margin-right: -12px;
+
+ border-top: 1px solid #ffd2ed;
+ border-bottom: 1px solid #ffd2ed;
+ border-left: 0px;
+ border-right: 0px;
+}
+
+.rst-content .admonition-example > div[class^="highlight"]:nth-child(2) {
+ /* If a code box is the second element in an example admonition,
+ * it is the first child after the title. let it sit flush against
+ * the title. */
+ margin-top: -12px;
+ border-top: 0px;
+}
+
+.rst-content .admonition-example > div[class^="highlight"]:last-child {
+ /* If a code box is the final element in an example admonition, don't
+ * render margin below it; let it sit flush with the end of the
+ * admonition box */
+ margin-bottom: -12px;
+ border-bottom: 0px;
+}
+
+.rst-content .admonition-example .highlight {
+ background-color: #fffafd;
+}
+
+/* end qmp-example styling */
+
@media screen {
/* content column
--
2.45.0
- [PATCH v2 0/9] qapi: convert example sections to qmp-example rST directives, John Snow, 2024/07/16
- [PATCH v2 1/9] [DO-NOT-MERGE]: Add some ad-hoc linting helpers., John Snow, 2024/07/16
- [PATCH v2 3/9] docs/qapidoc: create qmp-example directive, John Snow, 2024/07/16
- [PATCH v2 4/9] docs/qapidoc: add QMP highlighting to annotated qmp-example blocks, John Snow, 2024/07/16
- [PATCH v2 2/9] docs/qapidoc: factor out do_parse(), John Snow, 2024/07/16
- [PATCH v2 5/9] docs/sphinx: add CSS styling for qmp-example directive,
John Snow <=
- [PATCH v2 6/9] qapi: convert "Example" sections without titles, John Snow, 2024/07/16
- [PATCH v2 7/9] qapi: convert "Example" sections with titles, John Snow, 2024/07/16
- [PATCH v2 8/9] qapi: convert "Example" sections with longer prose, John Snow, 2024/07/16
- [PATCH v2 9/9] qapi: remove "Example" doc section, John Snow, 2024/07/16
- Re: [PATCH v2 0/9] qapi: convert example sections to qmp-example rST directives, Markus Armbruster, 2024/07/17