diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml
index 4e8d5f0..18641d5 100644
--- a/.github/workflows/doxygen.yml
+++ b/.github/workflows/doxygen.yml
@@ -30,5 +30,5 @@ jobs:
uses: nRF24/.github/.github/workflows/build_docs.yaml@main
with:
deploy-gh-pages: ${{ github.event_name == 'release' || (github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/master') }}
- doxygen-version: '1.10.0'
+ doxygen-version: '1.11.0'
secrets: inherit
diff --git a/docs/doxygen-custom.css b/docs/doxygen-custom.css
index 2b5ef5a..4a3c469 100644
--- a/docs/doxygen-custom.css
+++ b/docs/doxygen-custom.css
@@ -2,33 +2,74 @@ table.markdownTable th {
color: unset;
}
-/* overrides from default CSSS for some admonitions */
-dl.note, dl.remark,
-dl.warning, dl.attention {
+/* overrides from default CSS for some admonitions */
+dl.note,
+dl.remark,
+dl.warning,
+dl.attention,
+dl.important,
+dl.deprecated,
+dl.see {
color: unset;
+ box-shadow: 5px 5px 5px hsla(0, 0%, 19.2%, 0.5);
}
+
dl.remark {
- background: var(--remark-color-bg);
- border-left: 8px solid var(--remark-color-hl);
+ background: var(--remark-color-bg);
+ border-left: 8px solid var(--remark-color-hl);
}
+
dl.remark dt {
- color: var(--remark-color-hl);
+ color: var(--remark-color-hl);
+}
+
+dl.important dt {
+ color: var(--important-color-hl);
+}
+
+dl.important {
+ background: var(--important-color-bg);
+ border-left: 8px solid var(--important-color-hl);
+}
+
+dl.attention dt {
+ color: var(--attention-color-hl);
+}
+
+dl.attention {
+ background: var(--attention-color-bg);
+ border-left: 8px solid var(--attention-color-hl);
+}
+
+dl.deprecated dt {
+ color: var(--deprecated-color-hl);
+}
+
+dl.deprecated {
+ background: var(--deprecated-color-bg);
+ border-left: 8px solid var(--deprecated-color-hl);
}
/* special rules to accent `/see` or `/sa` command output */
dl.see {
- background: var(--seealso-color-bg);
- border-left: 8px solid var(--seealso-color-hl);
+ background: var(--seealso-color-bg);
+ border-left: 8px solid var(--seealso-color-hl);
}
+
dl.see dt {
- color: var(--seealso-color-hl);
+ color: var(--seealso-color-hl);
}
+
dl.see {
padding: 10px;
- margin: 10px 0px;
- overflow: hidden;
- margin-left: 0;
- border-radius: 4px;
+ margin: 10px 0px;
+ overflow: hidden;
+ margin-left: 0;
+ border-radius: 4px;
+}
+
+dl.see dd {
+ margin-left: 0;
}
/* admonition icons */
@@ -36,72 +77,90 @@ dl.note dt::before {
background-color: var(--note-color-hl);
mask-image: var(--note-icon);
}
+
dl.see dt::before {
background-color: var(--seealso-color-hl);
mask-image: var(--seealso-icon);
}
+
dl.remark dt::before {
background-color: var(--remark-color-hl);
mask-image: var(--remark-icon);
}
+
dl.warning dt::before {
background-color: var(--warning-color-hl);
mask-image: var(--warning-icon);
}
+
dl.deprecated dt::before {
background-color: var(--deprecated-color-hl);
mask-image: var(--deprecated-icon);
}
+
+dl.important dt::before {
+ background-color: var(--important-color-hl);
+ mask-image: var(--important-icon);
+}
+
+dl.attention dt::before {
+ background-color: var(--attention-color-hl);
+ mask-image: var(--attention-icon);
+}
+
dl.note dt::before,
dl.see dt::before,
dl.warning dt::before,
dl.remark dt::before,
-dl.deprecated dt::before {
- vertical-align: middle;
- background-repeat: no-repeat;
- content: "";
- display: inline-block;
- height: 2em;
- width: 2em;
+dl.deprecated dt::before,
+dl.important dt::before,
+dl.attention dt::before {
+ vertical-align: middle;
+ background-repeat: no-repeat;
+ content: "";
+ display: inline-block;
+ height: 2em;
+ width: 2em;
margin-right: 0.25rem;
}
+
dl.note dt,
dl.see dt,
dl.warning dt,
dl.remark dt,
-dl.deprecated dt {
+dl.deprecated dt,
+dl.important dt,
+dl.attention dt {
margin-top: -0.35em;
margin-bottom: 0.5em;
}
/* icon SVG data */
*:root {
- --note-icon: url('data:image/svg+xml;utf8,');
- --seealso-icon: url('data:image/svg+xml;utf8,');
+ --note-icon: url('data:image/svg+xml;utf8,');
--warning-icon: url('data:image/svg+xml;utf8,');
- --remark-icon: url('data:image/svg+xml;utf8,');
+ --remark-icon: url('data:image/svg+xml;utf8,');
+ --attention-icon: url('data:image/svg+xml;utf8,');
+ --important-icon: url('data:image/svg+xml;utf8,');
+ --seealso-icon: url('data:image/svg+xml;utf8,');
--deprecated-icon: url('data:image/svg+xml;utf8,');
}
/* color overrides */
-html {
- /* light theme CSS variables */
- --note-color-bg: hsla(47.6, 77.3%, 91.4%, 65%);
- --warning-color-bg: hsla(6.8, 75.9%, 88.6%, 65%);
- --deprecated-color-bg: hsla(205.7, 22.6%, 93.9%, 65%);
- --seealso-color-bg: hsla(215, 76%, 89%, 65%);
- --seealso-color-hl: hsl(215, 98%, 48%);
- --remark-color-bg: hsla(133, 75%, 89%, 65%);
- --remark-color-hl: hsl(133, 98.9%, 35.3%);
-}
-
+html,
html.dark-mode {
- /* dark theme CSS variables */
- --note-color-bg: hsla(45.8, 87.3%, 12.4%, 65%);
- --warning-color-bg: hsla(5.2, 33.3%, 13.5%, 65%);
- --deprecated-color-bg: hsla(221.5, 12.4%, 20.6%, 65%);
- --seealso-color-bg: hsla(215, 33%, 14%, 0.65);
- --seealso-color-hl: hsl(215, 98%, 48%);
- --remark-color-bg: hsla(133, 32%, 14%, 65%);
- --remark-color-hl: hsl(133, 98%, 48%);
+ --note-color-hl: hsl(213.7, 92.8%, 62%);
+ --note-color-bg: hsla(213.7, 92.8%, 62%, 12.5%);
+ --warning-color-hl: hsl(40.6, 72.1%, 47.8%);
+ --warning-color-bg: hsla(40.6, 72.1%, 47.8%, 12.5%);
+ --attention-color-hl: hsl(2.7, 92.6%, 62.9%);
+ --attention-color-bg: hsla(2.7, 92.6%, 62.9%, 12.5%);
+ --deprecated-color-hl: hsl(0, 0%, 47%);
+ --deprecated-color-bg: hsla(0, 0%, 47%, 12.5%);
+ --seealso-color-hl: hsl(323, 72%, 52%);
+ --seealso-color-bg: hsla(323, 72%, 52%, 12.5%);
+ --remark-color-hl: hsl(128.4, 49.2%, 48.6%);
+ --remark-color-bg: hsla(128.4, 49.2%, 48.6%, 12.5%);
+ --important-color-hl: hsl(262.4, 89.8%, 73.1%);
+ --important-color-bg: hsla(262.4, 89.8%, 73.1%, 12.5%);
}
\ No newline at end of file