From af6276d47e8a04d1dd6e3eb2a662ab228bcc2887 Mon Sep 17 00:00:00 2001 From: Zuri Klaschka Date: Sat, 14 Dec 2024 22:41:02 +0100 Subject: [PATCH] Fix broken Docs build through updating Frontend API Reference Pipeline The dependency upgrades took a few configuration changes which are implemented with this commit. --- docs/docker-compose.yml | 6 +- docs/docs/_css/custom.css | 149 ++++++++++++++++++++---------------- frontend-react/.gitignore | 1 + frontend-react/typedoc.json | 13 +++- 4 files changed, 97 insertions(+), 72 deletions(-) diff --git a/docs/docker-compose.yml b/docs/docker-compose.yml index f11b900f..ca0a13e4 100644 --- a/docs/docker-compose.yml +++ b/docs/docker-compose.yml @@ -47,7 +47,11 @@ services: && mv /tmp/docs-output/* /docs " volumes: - - ../frontend-react:/app + - ../frontend-react/package.json:/app/package.json + - ../frontend-react/src:/app/src + - ../frontend-react/typedoc.json:/app/typedoc.json + - ../frontend-react/tsconfig.json:/app/tsconfig.json + - ../frontend-react/tsconfig.node.json:/app/tsconfig.node.json - frontend-react-docs:/docs profiles: - deps diff --git a/docs/docs/_css/custom.css b/docs/docs/_css/custom.css index 59d4f757..256a6ef4 100644 --- a/docs/docs/_css/custom.css +++ b/docs/docs/_css/custom.css @@ -1,115 +1,130 @@ [data-md-color-scheme="slate"] { - --md-hue: 255; + --md-hue: 255; } [data-md-color-scheme="slate"] img.invertible { - filter: invert(1) hue-rotate(180deg) brightness(2); - mix-blend-mode: screen; + filter: invert(1) hue-rotate(180deg) brightness(2); + mix-blend-mode: screen; } :root { - --md-primary-fg-color: #452897; - --md-primary-fg-color--light: #704ed2; - --md-primary-fg-color--dark: #1f0e4f; - --md-accent-fg-color: #452897; - --md-accent-fg-color--light: #704ed2; - --md-accent-fg-color--dark: #1f0e4f; - - --md-text-font: "Roboto", Arial, sans-serif; - --md-code-font: "Roboto Mono", monospace; + --md-primary-fg-color: #452897; + --md-primary-fg-color--light: #704ed2; + --md-primary-fg-color--dark: #1f0e4f; + --md-accent-fg-color: #452897; + --md-accent-fg-color--light: #704ed2; + --md-accent-fg-color--dark: #1f0e4f; + + --md-text-font: "Roboto", Arial, sans-serif; + --md-code-font: "Roboto Mono", monospace; } .md-banner a { - color: white; - text-decoration: underline; + color: white; + text-decoration: underline; } .md-banner a:hover { - color: white; - text-decoration: none; + color: white; + text-decoration: none; } /*Fonts*/ @font-face { - font-family: 'Roboto'; - font-style: normal; - font-weight: 300; - font-display: fallback; - src: url(./Roboto/Roboto-Light.ttf); + font-family: "Roboto"; + font-style: normal; + font-weight: 300; + font-display: fallback; + src: url(./Roboto/Roboto-Light.ttf); } @font-face { - font-family: 'Roboto'; - font-style: italic; - font-weight: 300; - font-display: fallback; - src: url(./Roboto/Roboto-LightItalic.ttf); + font-family: "Roboto"; + font-style: italic; + font-weight: 300; + font-display: fallback; + src: url(./Roboto/Roboto-LightItalic.ttf); } @font-face { - font-family: 'Roboto'; - font-style: normal; - font-weight: 400; - font-display: fallback; - src: url(./Roboto/Roboto-Regular.ttf); + font-family: "Roboto"; + font-style: normal; + font-weight: 400; + font-display: fallback; + src: url(./Roboto/Roboto-Regular.ttf); } @font-face { - font-family: 'Roboto'; - font-style: italic; - font-weight: 400; - font-display: fallback; - src: url(./Roboto/Roboto-Italic.ttf); + font-family: "Roboto"; + font-style: italic; + font-weight: 400; + font-display: fallback; + src: url(./Roboto/Roboto-Italic.ttf); } @font-face { - font-family: 'Roboto'; - font-style: normal; - font-weight: 700; - font-display: fallback; - src: url(./Roboto/Roboto-Bold.ttf); + font-family: "Roboto"; + font-style: normal; + font-weight: 700; + font-display: fallback; + src: url(./Roboto/Roboto-Bold.ttf); } @font-face { - font-family: 'Roboto'; - font-style: italic; - font-weight: 700; - font-display: fallback; - src: url(./Roboto/Roboto-BoldItalic.ttf); + font-family: "Roboto"; + font-style: italic; + font-weight: 700; + font-display: fallback; + src: url(./Roboto/Roboto-BoldItalic.ttf); } - /*Roboto Mono*/ @font-face { - font-family: 'Roboto Mono'; - font-style: normal; - font-weight: 400; - font-display: fallback; - src: url(./Roboto_Mono/RobotoMono-Regular.ttf); + font-family: "Roboto Mono"; + font-style: normal; + font-weight: 400; + font-display: fallback; + src: url(./Roboto_Mono/RobotoMono-Regular.ttf); } @font-face { - font-family: 'Roboto Mono'; - font-style: italic; - font-weight: 400; - font-display: fallback; - src: url(./Roboto_Mono/RobotoMono-Italic.ttf); + font-family: "Roboto Mono"; + font-style: italic; + font-weight: 400; + font-display: fallback; + src: url(./Roboto_Mono/RobotoMono-Italic.ttf); } @font-face { - font-family: 'Roboto Mono'; - font-style: normal; - font-weight: 700; - font-display: fallback; - src: url(./Roboto_Mono/RobotoMono-Bold.ttf); + font-family: "Roboto Mono"; + font-style: normal; + font-weight: 700; + font-display: fallback; + src: url(./Roboto_Mono/RobotoMono-Bold.ttf); } @font-face { - font-family: 'Roboto Mono'; - font-style: italic; - font-weight: 700; - font-display: fallback; - src: url(./Roboto_Mono/RobotoMono-BoldItalic.ttf); + font-family: "Roboto Mono"; + font-style: italic; + font-weight: 700; + font-display: fallback; + src: url(./Roboto_Mono/RobotoMono-BoldItalic.ttf); +} + +/* Prevent smallcaps in headers */ +.md-typeset h1, +.md-typeset h2, +.md-typeset h3, +.md-typeset h4, +.md-typeset h5, +.md-typeset h6 { + color: var(--md-typeset-color); + text-transform: none; +} + +.md-typeset h5, +.md-typeset h6 { + font-size: 1em; } diff --git a/frontend-react/.gitignore b/frontend-react/.gitignore index cfc6c15f..3d00763e 100644 --- a/frontend-react/.gitignore +++ b/frontend-react/.gitignore @@ -12,6 +12,7 @@ dist dist-ssr types doc +/docs *.local # Editor directories and files diff --git a/frontend-react/typedoc.json b/frontend-react/typedoc.json index 031b5a87..ae2e3e94 100644 --- a/frontend-react/typedoc.json +++ b/frontend-react/typedoc.json @@ -15,6 +15,7 @@ "./src/lib/utils", "./src/lib/widget" ], + "entryModule": "index", "out": "docs", "githubPages": false, "validation": { @@ -24,10 +25,14 @@ }, "hideGenerator": true, "disableSources": true, - "hideInPageTOC": true, - "outputFileStrategy": "members", + "outputFileStrategy": "modules", + "hideBreadcrumbs": true, "hidePageTitle": true, "hidePageHeader": true, - "indexPageTitle": "API Reference", - "readme": "none" + "pageTitleTemplates": { + "index": "API Reference" + }, + "useCodeBlocks": true, + "readme": "none", + "useHTMLAnchors": true }