Skip to content

Commit ed31ad6

Browse files
2bndy52bndy5
committed
update doxygen CSS and use v1.11.0
1 parent 0fae40c commit ed31ad6

File tree

2 files changed

+103
-44
lines changed

2 files changed

+103
-44
lines changed

‎.github/workflows/doxygen.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,5 +34,5 @@ jobs:
3434
uses: nRF24/.github/.github/workflows/build_docs.yaml@main
3535
with:
3636
deploy-gh-pages: ${{ github.event_name == 'release' || (github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/master') }}
37-
doxygen-version: '1.10.0'
37+
doxygen-version: '1.11.0'
3838
secrets: inherit

‎docs/doxygen-custom.css

+102-43
Original file line numberDiff line numberDiff line change
@@ -2,106 +2,165 @@ table.markdownTable th {
22
color: unset;
33
}
44

5-
/* overrides from default CSSS for some admonitions */
6-
dl.note, dl.remark,
7-
dl.warning, dl.attention {
5+
/* overrides from default CSS for some admonitions */
6+
dl.note,
7+
dl.remark,
8+
dl.warning,
9+
dl.attention,
10+
dl.important,
11+
dl.deprecated,
12+
dl.see {
813
color: unset;
14+
box-shadow: 5px 5px 5px hsla(0, 0%, 19.2%, 0.5);
915
}
16+
1017
dl.remark {
11-
background: var(--remark-color-bg);
12-
border-left: 8px solid var(--remark-color-hl);
18+
background: var(--remark-color-bg);
19+
border-left: 8px solid var(--remark-color-hl);
1320
}
21+
1422
dl.remark dt {
15-
color: var(--remark-color-hl);
23+
color: var(--remark-color-hl);
24+
}
25+
26+
dl.important dt {
27+
color: var(--important-color-hl);
28+
}
29+
30+
dl.important {
31+
background: var(--important-color-bg);
32+
border-left: 8px solid var(--important-color-hl);
33+
}
34+
35+
dl.attention dt {
36+
color: var(--attention-color-hl);
37+
}
38+
39+
dl.attention {
40+
background: var(--attention-color-bg);
41+
border-left: 8px solid var(--attention-color-hl);
42+
}
43+
44+
dl.deprecated dt {
45+
color: var(--deprecated-color-hl);
46+
}
47+
48+
dl.deprecated {
49+
background: var(--deprecated-color-bg);
50+
border-left: 8px solid var(--deprecated-color-hl);
1651
}
1752

1853
/* special rules to accent `/see` or `/sa` command output */
1954
dl.see {
20-
background: var(--seealso-color-bg);
21-
border-left: 8px solid var(--seealso-color-hl);
55+
background: var(--seealso-color-bg);
56+
border-left: 8px solid var(--seealso-color-hl);
2257
}
58+
2359
dl.see dt {
24-
color: var(--seealso-color-hl);
60+
color: var(--seealso-color-hl);
2561
}
62+
2663
dl.see {
2764
padding: 10px;
28-
margin: 10px 0px;
29-
overflow: hidden;
30-
margin-left: 0;
31-
border-radius: 4px;
65+
margin: 10px 0px;
66+
overflow: hidden;
67+
margin-left: 0;
68+
border-radius: 4px;
69+
}
70+
71+
dl.see dd {
72+
margin-left: 0;
3273
}
3374

3475
/* admonition icons */
3576
dl.note dt::before {
3677
background-color: var(--note-color-hl);
3778
mask-image: var(--note-icon);
3879
}
80+
3981
dl.see dt::before {
4082
background-color: var(--seealso-color-hl);
4183
mask-image: var(--seealso-icon);
4284
}
85+
4386
dl.remark dt::before {
4487
background-color: var(--remark-color-hl);
4588
mask-image: var(--remark-icon);
4689
}
90+
4791
dl.warning dt::before {
4892
background-color: var(--warning-color-hl);
4993
mask-image: var(--warning-icon);
5094
}
95+
5196
dl.deprecated dt::before {
5297
background-color: var(--deprecated-color-hl);
5398
mask-image: var(--deprecated-icon);
5499
}
100+
101+
dl.important dt::before {
102+
background-color: var(--important-color-hl);
103+
mask-image: var(--important-icon);
104+
}
105+
106+
dl.attention dt::before {
107+
background-color: var(--attention-color-hl);
108+
mask-image: var(--attention-icon);
109+
}
110+
55111
dl.note dt::before,
56112
dl.see dt::before,
57113
dl.warning dt::before,
58114
dl.remark dt::before,
59-
dl.deprecated dt::before {
60-
vertical-align: middle;
61-
background-repeat: no-repeat;
62-
content: "";
63-
display: inline-block;
64-
height: 2em;
65-
width: 2em;
115+
dl.deprecated dt::before,
116+
dl.important dt::before,
117+
dl.attention dt::before {
118+
vertical-align: middle;
119+
background-repeat: no-repeat;
120+
content: "";
121+
display: inline-block;
122+
height: 2em;
123+
width: 2em;
66124
margin-right: 0.25rem;
67125
}
126+
68127
dl.note dt,
69128
dl.see dt,
70129
dl.warning dt,
71130
dl.remark dt,
72-
dl.deprecated dt {
131+
dl.deprecated dt,
132+
dl.important dt,
133+
dl.attention dt {
73134
margin-top: -0.35em;
74135
margin-bottom: 0.5em;
75136
}
76137

77138
/* icon SVG data */
78139
*:root {
79-
--note-icon: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 -960 960 960"><path d="M200-200h57l391-391-57-57-391 391v57Zm-80 80v-170l528-527q12-11 26.5-17t30.5-6q16 0 31 6t26 18l55 56q12 11 17.5 26t5.5 30q0 16-5.5 30.5T817-647L290-120H120Zm640-584-56-56 56 56Zm-141 85-28-29 57 57-29-28Z"/></svg>');
80-
--seealso-icon: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 -960 960 960"><path d="M480-320q75 0 127.5-52.5T660-500q0-75-52.5-127.5T480-680q-75 0-127.5 52.5T300-500q0 75 52.5 127.5T480-320Zm0-72q-45 0-76.5-31.5T372-500q0-45 31.5-76.5T480-608q45 0 76.5 31.5T588-500q0 45-31.5 76.5T480-392Zm0 192q-146 0-266-81.5T40-500q54-137 174-218.5T480-800q146 0 266 81.5T920-500q-54 137-174 218.5T480-200Zm0-300Zm0 220q113 0 207.5-59.5T832-500q-50-101-144.5-160.5T480-720q-113 0-207.5 59.5T128-500q50 101 144.5 160.5T480-280Z"/></svg>');
140+
--note-icon: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 -960 960 960"><path d="M480-280q17 0 28.5-11.5T520-320v-160q0-17-11.5-28.5T480-520q-17 0-28.5 11.5T440-480v160q0 17 11.5 28.5T480-280Zm0-320q17 0 28.5-11.5T520-640q0-17-11.5-28.5T480-680q-17 0-28.5 11.5T440-640q0 17 11.5 28.5T480-600Zm0 520q-83 0-156-31.5T197-197q-54-54-85.5-127T80-480q0-83 31.5-156T197-763q54-54 127-85.5T480-880q83 0 156 31.5T763-763q54 54 85.5 127T880-480q0 83-31.5 156T763-197q-54 54-127 85.5T480-80Zm0-80q134 0 227-93t93-227q0-134-93-227t-227-93q-134 0-227 93t-93 227q0 134 93 227t227 93Zm0-320Z"/></svg>');
81141
--warning-icon: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 -960 960 960"><path d="m40-120 440-760 440 760H40Zm138-80h604L480-720 178-200Zm302-40q17 0 28.5-11.5T520-280q0-17-11.5-28.5T480-320q-17 0-28.5 11.5T440-280q0 17 11.5 28.5T480-240Zm-40-120h80v-200h-80v200Zm40-100Z"/></svg>');
82-
--remark-icon: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 -960 960 960"><path d="M382-240 154-468l57-57 171 171 367-367 57 57-424 424Z"/></svg>');
142+
--remark-icon: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 -960 960 960"><path d="M480-80q-33 0-56.5-23.5T400-160h160q0 33-23.5 56.5T480-80ZM360-200q-17 0-28.5-11.5T320-240q0-17 11.5-28.5T360-280h240q17 0 28.5 11.5T640-240q0 17-11.5 28.5T600-200H360Zm-30-120q-69-41-109.5-110T180-580q0-125 87.5-212.5T480-880q125 0 212.5 87.5T780-580q0 81-40.5 150T630-320H330Zm24-80h252q45-32 69.5-79T700-580q0-92-64-156t-156-64q-92 0-156 64t-64 156q0 54 24.5 101t69.5 79Zm126 0Z"/></svg>');
143+
--attention-icon: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 -960 960 960"><path d="M480-280q17 0 28.5-11.5T520-320q0-17-11.5-28.5T480-360q-17 0-28.5 11.5T440-320q0 17 11.5 28.5T480-280Zm0-160q17 0 28.5-11.5T520-480v-160q0-17-11.5-28.5T480-680q-17 0-28.5 11.5T440-640v160q0 17 11.5 28.5T480-440ZM363-120q-16 0-30.5-6T307-143L143-307q-11-11-17-25.5t-6-30.5v-234q0-16 6-30.5t17-25.5l164-164q11-11 25.5-17t30.5-6h234q16 0 30.5 6t25.5 17l164 164q11 11 17 25.5t6 30.5v234q0 16-6 30.5T817-307L653-143q-11 11-25.5 17t-30.5 6H363Zm1-80h232l164-164v-232L596-760H364L200-596v232l164 164Zm116-280Z"/></svg>');
144+
--important-icon: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 -960 960 960"><path d="M480-360q17 0 28.5-11.5T520-400q0-17-11.5-28.5T480-440q-17 0-28.5 11.5T440-400q0 17 11.5 28.5T480-360Zm0-160q17 0 28.5-11.5T520-560v-160q0-17-11.5-28.5T480-760q-17 0-28.5 11.5T440-720v160q0 17 11.5 28.5T480-520ZM240-240l-92 92q-19 19-43.5 8.5T80-177v-623q0-33 23.5-56.5T160-880h640q33 0 56.5 23.5T880-800v480q0 33-23.5 56.5T800-240H240Zm-34-80h594v-480H160v525l46-45Zm-46 0v-480 480Z"/></svg>');
145+
--seealso-icon: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 -960 960 960"><path d="M480-320q75 0 127.5-52.5T660-500q0-75-52.5-127.5T480-680q-75 0-127.5 52.5T300-500q0 75 52.5 127.5T480-320Zm0-72q-45 0-76.5-31.5T372-500q0-45 31.5-76.5T480-608q45 0 76.5 31.5T588-500q0 45-31.5 76.5T480-392Zm0 192q-146 0-266-81.5T40-500q54-137 174-218.5T480-800q146 0 266 81.5T920-500q-54 137-174 218.5T480-200Zm0-300Zm0 220q113 0 207.5-59.5T832-500q-50-101-144.5-160.5T480-720q-113 0-207.5 59.5T128-500q50 101 144.5 160.5T480-280Z"/></svg>');
83146
--deprecated-icon: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 -960 960 960"><path d="M280-120q-33 0-56.5-23.5T200-200v-520h-40v-80h200v-40h240v40h200v80h-40v520q0 33-23.5 56.5T680-120H280Zm400-600H280v520h400v-520ZM360-280h80v-360h-80v360Zm160 0h80v-360h-80v360ZM280-720v520-520Z"/></svg>');
84147
}
85148

86149
/* color overrides */
87-
html {
88-
/* light theme CSS variables */
89-
--note-color-bg: hsla(47.6, 77.3%, 91.4%, 65%);
90-
--warning-color-bg: hsla(6.8, 75.9%, 88.6%, 65%);
91-
--deprecated-color-bg: hsla(205.7, 22.6%, 93.9%, 65%);
92-
--seealso-color-bg: hsla(215, 76%, 89%, 65%);
93-
--seealso-color-hl: hsl(215, 98%, 48%);
94-
--remark-color-bg: hsla(133, 75%, 89%, 65%);
95-
--remark-color-hl: hsl(133, 98.9%, 35.3%);
96-
}
97-
150+
html,
98151
html.dark-mode {
99-
/* dark theme CSS variables */
100-
--note-color-bg: hsla(45.8, 87.3%, 12.4%, 65%);
101-
--warning-color-bg: hsla(5.2, 33.3%, 13.5%, 65%);
102-
--deprecated-color-bg: hsla(221.5, 12.4%, 20.6%, 65%);
103-
--seealso-color-bg: hsla(215, 33%, 14%, 0.65);
104-
--seealso-color-hl: hsl(215, 98%, 48%);
105-
--remark-color-bg: hsla(133, 32%, 14%, 65%);
106-
--remark-color-hl: hsl(133, 98%, 48%);
152+
--note-color-hl: hsl(213.7, 92.8%, 62%);
153+
--note-color-bg: hsla(213.7, 92.8%, 62%, 12.5%);
154+
--warning-color-hl: hsl(40.6, 72.1%, 47.8%);
155+
--warning-color-bg: hsla(40.6, 72.1%, 47.8%, 12.5%);
156+
--attention-color-hl: hsl(2.7, 92.6%, 62.9%);
157+
--attention-color-bg: hsla(2.7, 92.6%, 62.9%, 12.5%);
158+
--deprecated-color-hl: hsl(0, 0%, 47%);
159+
--deprecated-color-bg: hsla(0, 0%, 47%, 12.5%);
160+
--seealso-color-hl: hsl(323, 72%, 52%);
161+
--seealso-color-bg: hsla(323, 72%, 52%, 12.5%);
162+
--remark-color-hl: hsl(128.4, 49.2%, 48.6%);
163+
--remark-color-bg: hsla(128.4, 49.2%, 48.6%, 12.5%);
164+
--important-color-hl: hsl(262.4, 89.8%, 73.1%);
165+
--important-color-bg: hsla(262.4, 89.8%, 73.1%, 12.5%);
107166
}

0 commit comments

Comments
 (0)