Skip to content

Commit 991b286

Browse files
author
Elia Palme
committed
Auto build hp-pages
1 parent 5e73404 commit 991b286

File tree

5 files changed

+254
-0
lines changed

5 files changed

+254
-0
lines changed

‎.github/workflows/docs.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: publish docs
2+
3+
on:
4+
push:
5+
branches: [ "IRAM-306-build-doc" ]
6+
release:
7+
types: [released]
8+
9+
permissions:
10+
contents: write
11+
jobs:
12+
deploy:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v3
16+
- uses: actions/setup-python@v4
17+
with:
18+
python-version: 3.x
19+
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
20+
- uses: actions/cache@v3
21+
with:
22+
key: mkdocs-material-${{ env.cache_id }}
23+
path: .cache
24+
restore-keys: |
25+
mkdocs-material-
26+
- run: pip install --upgrade pip
27+
- run: |
28+
pip install -r ./docs/requirements.txt
29+
- run: rm -rf site
30+
- run: mkdocs gh-deploy

‎docs/assets/cscs-logo.png

9.77 KB
Loading

‎docs/requirements.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
mkdocs
2+
mkdocs-material
3+
mkdocs-autorefs

‎docs/stylesheets/extra.css

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
:root {
2+
--md-admonition-icon--alps: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M256 32c12.5 0 24.1 6.4 30.8 17l216.6 345.4c5.6 8.9 8.6 19.2 8.6 29.7 0 30.9-25 55.9-55.9 55.9H55.9C25 480 0 455 0 424.1c0-10.5 3-20.8 8.6-29.7L225.2 49c6.6-10.6 18.3-17 30.8-17zm65 192-65-103.6-79.1 126.1 18.3 24.4c6.4 8.5 19.2 8.5 25.6 0l25.6-34.1c6-8.1 15.5-12.8 25.6-12.8h49z"/></svg>');
3+
--base-border-radius: 0.2rem;
4+
--base-border-width: 0.05rem;
5+
}
6+
.md-typeset .admonition.alps,
7+
.md-typeset details.alps {
8+
border-color: rgb(255, 51, 51);
9+
}
10+
.md-typeset .alps > .admonition-title,
11+
.md-typeset .alps > summary {
12+
background-color: rgba(255, 51, 51, 0.1);
13+
}
14+
.md-typeset .alps > .admonition-title::before,
15+
.md-typeset .alps > summary::before {
16+
background-color: rgb(255, 51, 51);
17+
-webkit-mask-image: var(--md-admonition-icon--alps);
18+
mask-image: var(--md-admonition-icon--alps);
19+
}
20+
.md-typeset .admonition.change,
21+
.md-typeset details.change {
22+
border-color: rgb(43, 155, 70);
23+
}
24+
.md-typeset .change > .admonition-title,
25+
.md-typeset .change > summary {
26+
background-color: rgba(43, 155, 70, 0.1);
27+
}
28+
.md-typeset .change > .admonition-title::before,
29+
.md-typeset .change > summary::before {
30+
background-color: rgb(43, 155, 70);
31+
-webkit-mask-image: var(--md-admonition-icon--alps);
32+
mask-image: var(--md-admonition-icon--alps);
33+
}
34+
35+
/* todo admonition */
36+
.md-typeset .admonition.todo,
37+
.md-typeset details.todo {
38+
border-color: rgb(255, 0, 0);
39+
}
40+
.md-typeset .todo > .admonition-title,
41+
.md-typeset .todo > summary {
42+
background-color: rgba(255, 0, 0, 0.1);
43+
}
44+
.md-typeset .todo > .admonition-title::before,
45+
.md-typeset .todo > summary::before {
46+
background-color: rgb(255, 0, 0);
47+
-webkit-mask-image: var(--md-admonition-icon--alps);
48+
mask-image: var(--md-admonition-icon--alps);
49+
}
50+
51+
.md-nav__item .md-nav__link--active {
52+
font-weight: bold;
53+
}
54+
55+
/* Light mode */
56+
[data-md-color-scheme="default"] .md-typeset .grid.cards > ul > li {
57+
border-radius: var(--base-border-radius);
58+
border-width: var(--base-border-width);
59+
border-color: #121417; /* Darker border for contrast */
60+
background-color: #ffffff; /* Ensures light background */
61+
color: #121417; /* Dark text for readability */
62+
}
63+
64+
[data-md-color-scheme="default"] .md-typeset .grid.cards > ul > li:hover {
65+
box-shadow: 0 0 0.5rem #010945; /* Dark blue shadow on hover */
66+
}
67+
68+
/* Dark mode */
69+
[data-md-color-scheme="slate"] .md-typeset .grid.cards > ul > li {
70+
border-radius: var(--base-border-radius);
71+
border-width: var(--base-border-width);
72+
border-color: #bbbbbb; /* Lighter border for better contrast in dark mode */
73+
background-color: #1a1a1a; /* Darker background to blend well */
74+
color: #e0e0e0; /* Lighter text for readability */
75+
}
76+
77+
[data-md-color-scheme="slate"] .md-typeset .grid.cards > ul > li:hover {
78+
box-shadow: 0 0 0.5rem #79aaff; /* Softer, lighter blue glow on hover */
79+
}
80+
81+
/* Table */
82+
.md-typeset table:not([class]) {
83+
border-radius: var(--base-border-radius);
84+
border-width: var(--base-border-width);
85+
border-color: #121417;
86+
}
87+
88+
/* code hilighting */
89+
90+
91+
/* light mode: pale yellow background, solid black foreground */
92+
[data-md-color-scheme="default"] {
93+
--md-code-bg-color: #fcfafa;
94+
--md-code-fg-color: #000000;
95+
}
96+
97+
/* Dark mode */
98+
[data-md-color-scheme="slate"] {
99+
--md-code-bg-color: #1e1e1e;
100+
--md-code-fg-color: #ffffff;
101+
}
102+
103+
/* Light mode */
104+
[data-md-color-scheme="default"] .md-typeset pre {
105+
border: 2px solid #fcb8b8;
106+
border-radius: 2px; /* slight rounding to corners */
107+
}
108+
109+
/* Dark mode */
110+
[data-md-color-scheme="slate"] .md-typeset pre {
111+
border: 2px solid #3f4013;
112+
border-radius: 2px;
113+
}

‎mkdocs.yml

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
site_name: FirecREST v2 Documentation
2+
3+
# provide a link to the docs in top RHS corner
4+
repo_url: https://github.com/eth-cscs/firecrest-v2/
5+
# provide a link to "edit this page" to each page
6+
edit_uri: edit/main/docs/
7+
8+
nav:
9+
- Welcome: index.md
10+
- 'API Reference':
11+
- api/README.md
12+
- 'Configuration':
13+
- conf/README.md
14+
- 'Deployment':
15+
- deploy/README.md
16+
- 'Usage':
17+
- use/README.md
18+
19+
theme:
20+
name: material
21+
language: en
22+
#custom_dir: docs/.overrides
23+
features:
24+
- content.code.copy
25+
# add an "edit this page" icon on each page
26+
- content.action.edit
27+
- navigation.indexes
28+
- search.share
29+
- navigation.instant
30+
- navigation.tracking
31+
- navigation.path
32+
- navigation.top
33+
icon:
34+
# set the icon for "edit this page"
35+
edit: material/pencil
36+
palette:
37+
# Palette toggle for automatic mode
38+
- media: "(prefers-color-scheme)"
39+
toggle:
40+
icon: material/brightness-auto
41+
name: Switch to light mode
42+
# Palette toggle for light mode
43+
- media: "(prefers-color-scheme: light)"
44+
scheme: default
45+
primary: white
46+
accent: blue
47+
toggle:
48+
icon: material/brightness-7
49+
name: Switch to dark mode
50+
51+
# Palette toggle for dark mode
52+
- media: "(prefers-color-scheme: dark)"
53+
scheme: slate
54+
primary: white
55+
accent: blue
56+
toggle:
57+
icon: material/brightness-4
58+
name: Switch to light mode
59+
60+
logo: assets/cscs-logo.png
61+
font:
62+
text: Roboto
63+
code: Roboto Mono
64+
65+
plugins:
66+
- search:
67+
pipeline:
68+
- trimmer
69+
- autorefs
70+
71+
markdown_extensions:
72+
- admonition
73+
- def_list
74+
- pymdownx.details
75+
- pymdownx.superfences
76+
- pymdownx.superfences:
77+
custom_fences:
78+
- name: mermaid
79+
class: mermaid
80+
format: !!python/name:pymdownx.superfences.fence_code_format
81+
- pymdownx.snippets
82+
- pymdownx.highlight:
83+
anchor_linenums: true
84+
line_spans: __span
85+
pygments_lang_class: true
86+
- pymdownx.emoji:
87+
emoji_index: !!python/name:material.extensions.emoji.twemoji
88+
emoji_generator: !!python/name:material.extensions.emoji.to_svg
89+
- pymdownx.tabbed:
90+
alternate_style: true
91+
- tables
92+
- toc:
93+
permalink: true
94+
- attr_list
95+
- md_in_html
96+
- footnotes
97+
- pymdownx.arithmatex:
98+
generic: true
99+
# for captioning images
100+
- pymdownx.blocks.caption
101+
102+
# disable mathjax until the "GET /javascripts/mathjax.js HTTP/1.1" code 404 errors are fixed
103+
#extra_javascript:
104+
# - javascripts/mathjax.js
105+
# - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
106+
107+
extra_css:
108+
- stylesheets/extra.css

0 commit comments

Comments
 (0)