Skip to content

Commit 77eb1e1

Browse files
chore(pre-commit.ci): auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
1 parent 514ceee commit 77eb1e1

File tree

6 files changed

+106
-101
lines changed

6 files changed

+106
-101
lines changed

docs/css/fonts.css

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
/* TODO: choose fonts */
44
:root {
5-
--md-text-font:
6-
"Roboto", "Verdana", "Arial", "Helvetica", sans-serif, ui-sans-serif,
7-
system-ui, "Segoe UI Emoji", "Noto Color Emoji", emoji;
8-
--md-code-font:
9-
"MonaspiceNe Nerd Font", "CaskaydiaCove Nerd Font", "FiraCode Nerd Font",
10-
"Monaspace Neon", "Cascadia Code", "FiraCode", "JetBrains Mono",
11-
ui-monospace, monospace, "Segoe UI Emoji", "Noto Color Emoji", emoji;
5+
--md-text-font:
6+
"Roboto", "Verdana", "Arial", "Helvetica", sans-serif, ui-sans-serif,
7+
system-ui, "Segoe UI Emoji", "Noto Color Emoji", emoji;
8+
--md-code-font:
9+
"MonaspiceNe Nerd Font", "CaskaydiaCove Nerd Font", "FiraCode Nerd Font",
10+
"Monaspace Neon", "Cascadia Code", "FiraCode", "JetBrains Mono",
11+
ui-monospace, monospace, "Segoe UI Emoji", "Noto Color Emoji", emoji;
1212
}
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
/* ref: https://github.com/tlambert03/mkdocs-api-autonav */
22
nav.md-nav code.doc-symbol.doc-symbol-nav {
3-
margin-right: 0.25em;
3+
margin-right: 0.25em;
44
}

docs/css/mkdocstrings/material.css

Lines changed: 53 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -2,77 +2,80 @@
22

33
/* Indentation. */
44
div.doc-contents:not(.first) {
5-
padding-left: 25px;
6-
border-left: 0.05rem solid var(--md-typeset-table-color);
5+
padding-left: 25px;
6+
border-left: 0.05rem solid var(--md-typeset-table-color);
77
}
88

99
/* Mark external links as such. */
1010
a.external::after,
1111
a.autorefs-external::after {
12-
/* https://primer.style/octicons/arrow-up-right-24 */
13-
mask-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18.25 15.5a.75.75 0 00.75-.75v-9a.75.75 0 00-.75-.75h-9a.75.75 0 000 1.5h7.19L6.22 16.72a.75.75 0 101.06 1.06L17.5 7.56v7.19c0 .414.336.75.75.75z"></path></svg>');
14-
content: " ";
15-
display: inline-block;
16-
vertical-align: middle;
17-
position: relative;
18-
height: 1em;
19-
width: 1em;
20-
background-color: currentcolor;
12+
/* https://primer.style/octicons/arrow-up-right-24 */
13+
mask-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18.25 15.5a.75.75 0 00.75-.75v-9a.75.75 0 00-.75-.75h-9a.75.75 0 000 1.5h7.19L6.22 16.72a.75.75 0 101.06 1.06L17.5 7.56v7.19c0 .414.336.75.75.75z"></path></svg>');
14+
content: " ";
15+
display: inline-block;
16+
vertical-align: middle;
17+
position: relative;
18+
height: 1em;
19+
width: 1em;
20+
background-color: currentcolor;
2121
}
2222

2323
a.external:hover::after,
2424
a.autorefs-external:hover::after {
25-
background-color: var(--md-accent-fg-color);
25+
background-color: var(--md-accent-fg-color);
2626
}
2727

2828
/* Tree-like output for backlinks. */
2929
.doc-backlink-list {
30-
--tree-clr: var(--md-default-fg-color);
31-
--tree-font-size: 1rem;
32-
--tree-item-height: 1;
33-
--tree-offset: 1rem;
34-
--tree-thickness: 1px;
35-
--tree-style: solid;
30+
--tree-clr: var(--md-default-fg-color);
31+
--tree-font-size: 1rem;
32+
--tree-item-height: 1;
33+
--tree-offset: 1rem;
34+
--tree-thickness: 1px;
35+
--tree-style: solid;
3636

37-
display: grid;
38-
list-style: none !important;
37+
display: grid;
38+
list-style: none !important;
3939
}
4040

4141
.doc-backlink-list li > span:first-child {
42-
text-indent: 0.3rem;
42+
text-indent: 0.3rem;
4343
}
4444

4545
.doc-backlink-list li {
46-
padding-inline-start: var(--tree-offset);
47-
border-left: var(--tree-thickness) var(--tree-style) var(--tree-clr);
48-
position: relative;
49-
margin-left: 0 !important;
46+
padding-inline-start: var(--tree-offset);
47+
border-left: var(--tree-thickness) var(--tree-style) var(--tree-clr);
48+
position: relative;
49+
margin-left: 0 !important;
5050

51-
&:last-child {
52-
border-color: transparent;
53-
}
51+
&:last-child {
52+
border-color: transparent;
53+
}
5454

55-
&::before {
56-
content: "";
57-
position: absolute;
58-
top: calc(
59-
var(--tree-item-height) / 2 * -1 * var(--tree-font-size) +
60-
var(--tree-thickness)
61-
);
62-
left: calc(var(--tree-thickness) * -1);
63-
width: calc(var(--tree-offset) + var(--tree-thickness) * 2);
64-
height: calc(var(--tree-item-height) * var(--tree-font-size));
65-
border-left: var(--tree-thickness) var(--tree-style) var(--tree-clr);
66-
border-bottom: var(--tree-thickness) var(--tree-style) var(--tree-clr);
67-
}
55+
&::before {
56+
content: "";
57+
position: absolute;
58+
top: calc(
59+
var(--tree-item-height) /
60+
2 *
61+
-1 *
62+
var(--tree-font-size) +
63+
var(--tree-thickness)
64+
);
65+
left: calc(var(--tree-thickness) * -1);
66+
width: calc(var(--tree-offset) + var(--tree-thickness) * 2);
67+
height: calc(var(--tree-item-height) * var(--tree-font-size));
68+
border-left: var(--tree-thickness) var(--tree-style) var(--tree-clr);
69+
border-bottom: var(--tree-thickness) var(--tree-style) var(--tree-clr);
70+
}
6871

69-
&::after {
70-
content: "";
71-
position: absolute;
72-
border-radius: 50%;
73-
background-color: var(--tree-clr);
74-
top: calc(var(--tree-item-height) / 2 * 1rem);
75-
left: var(--tree-offset);
76-
translate: calc(var(--tree-thickness) * -1) calc(var(--tree-thickness) * -1);
77-
}
72+
&::after {
73+
content: "";
74+
position: absolute;
75+
border-radius: 50%;
76+
background-color: var(--tree-clr);
77+
top: calc(var(--tree-item-height) / 2 * 1rem);
78+
left: var(--tree-offset);
79+
translate: calc(var(--tree-thickness) * -1) calc(var(--tree-thickness) * -1);
80+
}
7881
}

docs/css/mkdocstrings/syntax-highlight-in-signatures.css

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,19 @@
22

33
/* Fancier color for operators such as * and |. */
44
.doc-signature .o {
5-
color: var(--md-code-hl-special-color);
5+
color: var(--md-code-hl-special-color);
66
}
77

88
/* Fancier color for constants such as None, True, and False. */
99
.doc-signature .kc {
10-
color: var(--md-code-hl-constant-color);
10+
color: var(--md-code-hl-constant-color);
1111
}
1212

1313
/* Fancier color for built-in types (only useful when cross-references are used). */
14-
.doc-signature .n > a[href^="https://docs.python.org/"][href*="/functions.html#"],
15-
.doc-signature .n > a[href^="https://docs.python.org/"][href*="/stdtypes.html#"]
16-
{
17-
color: var(--md-code-hl-constant-color);
14+
.doc-signature .n
15+
> a[href^="https://docs.python.org/"][href*="/functions.html#"],
16+
.doc-signature
17+
.n
18+
> a[href^="https://docs.python.org/"][href*="/stdtypes.html#"] {
19+
color: var(--md-code-hl-constant-color);
1820
}

docs/javascript/mathjax.js

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
// ref: <https://squidfunk.github.io/mkdocs-material/reference/math/#mathjax>
22

33
window.MathJax = {
4-
tex: {
5-
inlineMath: [["\\(", "\\)"]],
6-
displayMath: [["\\[", "\\]"]],
7-
processEscapes: true,
8-
processEnvironments: true,
9-
},
10-
options: {
11-
ignoreHtmlClass: ".*|",
12-
processHtmlClass: "arithmatex",
13-
},
4+
tex: {
5+
inlineMath: [["\\(", "\\)"]],
6+
displayMath: [["\\[", "\\]"]],
7+
processEscapes: true,
8+
processEnvironments: true,
9+
},
10+
options: {
11+
ignoreHtmlClass: ".*|",
12+
processHtmlClass: "arithmatex",
13+
},
1414
};
1515

1616
document$.subscribe(() => {
17-
MathJax.startup.output.clearCache();
18-
MathJax.typesetClear();
19-
MathJax.texReset();
20-
MathJax.typesetPromise();
17+
MathJax.startup.output.clearCache();
18+
MathJax.typesetClear();
19+
MathJax.texReset();
20+
MathJax.typesetPromise();
2121
});

docs/javascript/readthedocs.js

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,44 @@
11
// ref: <https://docs.readthedocs.com/platform/stable/intro/mkdocs.html#integrate-the-read-the-docs-version-menu-into-your-site-navigation>
22

3-
document.addEventListener("DOMContentLoaded", function (event) {
4-
// Trigger Read the Docs' search addon instead of Material MkDocs default
5-
document.querySelector(".md-search__input").addEventListener("focus", (e) => {
6-
const event = new CustomEvent("readthedocs-search-show");
7-
document.dispatchEvent(event);
8-
});
3+
document.addEventListener("DOMContentLoaded", (event) => {
4+
// Trigger Read the Docs' search addon instead of Material MkDocs default
5+
document.querySelector(".md-search__input").addEventListener("focus", (e) => {
6+
const event = new CustomEvent("readthedocs-search-show");
7+
document.dispatchEvent(event);
8+
});
99
});
1010

1111
// Use CustomEvent to generate the version selector
12-
document.addEventListener("readthedocs-addons-data-ready", function (event) {
13-
const config = event.detail.data();
14-
const versioning = `
12+
document.addEventListener("readthedocs-addons-data-ready", (event) => {
13+
const config = event.detail.data();
14+
const versioning = `
1515
<div class="md-version">
1616
<button class="md-version__current" aria-label="Select version">
1717
${config.versions.current.slug}
1818
</button>
1919
2020
<ul class="md-version__list">
2121
${config.versions.active
22-
.map(
23-
(version) => `
22+
.map(
23+
(version) => `
2424
<li class="md-version__item">
2525
<a href="${version.urls.documentation}" class="md-version__link">
2626
${version.slug}
2727
</a>
2828
</li>`,
29-
)
30-
.join("\n")}
29+
)
30+
.join("\n")}
3131
</ul>
3232
</div>`;
3333

34-
// Check if we already added versions and remove them if so.
35-
// This happens when using the "Instant loading" feature.
36-
// See https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#instant-loading
37-
const currentVersions = document.querySelector(".md-version");
38-
if (currentVersions !== null) {
39-
currentVersions.remove();
40-
}
41-
document
42-
.querySelector(".md-header__topic")
43-
.insertAdjacentHTML("beforeend", versioning);
34+
// Check if we already added versions and remove them if so.
35+
// This happens when using the "Instant loading" feature.
36+
// See https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#instant-loading
37+
const currentVersions = document.querySelector(".md-version");
38+
if (currentVersions !== null) {
39+
currentVersions.remove();
40+
}
41+
document
42+
.querySelector(".md-header__topic")
43+
.insertAdjacentHTML("beforeend", versioning);
4444
});

0 commit comments

Comments
 (0)