scihpc/mkdocs.yml at main · smhr/scihpc · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
site_name: SciHPC
site_dir: 'public/'
theme:
  name: material
  custom_dir: docs/overrides
#  logo: assets/images/logo.png
  palette:
    # Palette toggle for light mode
    # - scheme: default
    - primary: teal
      accent: teal
      media: "(prefers-color-scheme: light)"
      toggle:
        icon: material/link
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      primary: black
      accent: indigo
      media: "(prefers-color-scheme: dark)"
      toggle:
        icon: material/toggle-switch-off
        name: Switch to light mode

  # palette:
  #   - media: "(prefers-color-scheme)"
  #     toggle:
  #       icon: material/link
  #       name: Switch to light mode
  #   - media: "(prefers-color-scheme: light)"
  #     scheme: default
  #     primary: indigo
  #     accent: indigo
  #     toggle:
  #       icon: material/toggle-switch
  #       name: Switch to dark mode
  #   - media: "(prefers-color-scheme: dark)"
  #     scheme: slate
  #     primary: black
  #     accent: indigo
  #     toggle:
  #       icon: material/toggle-switch-off
  #       name: Switch to system preference

  features:
    - navigation.tabs
    - navigation.tracking
    - navigation.indexes
    - navigation.top
    - navigation.tabs
    - navigation.tabs.sticky
    - search.suggest
    - search.highlight
    - content.action.edit
    - content.action.view
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
  icon:
    annotation: material/arrow-right-circle
site_url: !ENV READTHEDOCS_CANONICAL_URL
# repo_name: sci-hpc/scicluster
# repo_url: https://github.com/sci-hpc/scicluster
# edit_uri: edit/main/docs/
# docs_dir: docs
site_description: >-
  SciHPC tries to make High performance computing more simple and accessible.
copyright: Copyright &copy; 2023 - 2024 SciHPC team
# extra_javascript:
#   - assets/javascripts/versions.js
# extra_css:
  # - assets/stylesheets/versions.css
  # - assets/stylesheets/color-schemes.css
  # - assets/stylesheets/mermaid.css
plugins:
  - search
  - social:
      cards_layout_options:
        background_color: "#006bba"
  - include-markdown:
      trailing_newlines: false
  # - git-revision-date-localized:
  #     fallback_to_build_date: true
  - blog:
      post_excerpt: optional
      blog_dir: blog
      draft_if_future_date: true
markdown_extensions:
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - admonition
  - pymdownx.details
  - pymdownx.highlight:
      use_pygments: true
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}}
  - attr_list
  - md_in_html

nav:
  - Home:
      - index.md
  - Documentation:
      - Scicluster:
        - docs/index.md
        - docs/about/about-scicluster.md
        - docs/about/getting-started.md
        - docs/about/login.md
      - Storage:
        - docs/storage/storage.md
      - softwares:
        - docs/softwares/softwares.md
        - docs/softwares/modules.md
        - docs/softwares/python.md
        - Applications:
          - docs/softwares/apps/index.md
          - docs/softwares/apps/astrophysics/BHAC/BHAC.md
          - docs/softwares/apps/astrophysics/GADGET/GADGET-v4.md
          - docs/softwares/apps/astrophysics/GIZMO/GIZMO.md
          - docs/softwares/apps/math-stat/Mathematica.md
      - Development:
        - docs/development/compilers.md
        - docs/development/environment.md
        - docs/development/toolchains_easybuild.md
        - docs/development/building.md
      - Parallel computing:
        - docs/parallel_computing/intro.md
      - Managing jobs and workflows:
        - docs/jobs/dos_and_donts.md
        - docs/jobs/slurm.md
        - docs/jobs/partition.md
        - docs/jobs/qos.md
        - docs/jobs/examples.md
        - docs/jobs/interactive.md
        - docs/jobs/job_management.md
        - docs/jobs/monitoring.md
        - docs/jobs/running_mpi_jobs.md
      - Web Portal:
        - docs/web_portal/web_portal.md
      - Acknowledgment:
        - docs/acknowledgment/acknowledgment.md

  - Blog:
      - blog/index.md
  - Tutorial:
      - tutorial/index.md