srunx/mkdocs.yml at main · ksterx/srunx · 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
site_name: srunx
site_description: Slurm job workflow management
site_url: https://ksterx.github.io/srunx/
repo_url: https://github.com/ksterx/srunx
repo_name: ksterx/srunx
edit_uri: edit/main/docs/

docs_dir: docs
site_dir: public

theme:
  name: material
  custom_dir: overrides
  font: false
  logo: assets/images/icon.svg
  favicon: assets/images/icon.svg
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - toc.follow
    - content.code.copy
    - content.code.annotate
    - search.highlight
    - search.suggest
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: lime
      toggle:
        icon: material/weather-night
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      accent: lime
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
  icon:
    repo: fontawesome/brands/github

extra:
  # Paste the content value from Google Search Console (HTML tag verification).
  # Leave empty to skip emitting the meta tag.
  google_site_verification: "orUwpzx94uyyxETR5_t9C1noirNXCAuo6Me-VzwvOBA"

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - https://unpkg.com/mermaid@11/dist/mermaid.min.js
  - javascripts/mermaid-init.js

plugins:
  - search
  - glightbox:
      touchNavigation: true
      loop: false
      effect: zoom
      slide_effect: slide
      width: 100%
      height: auto
      zoomable: true
      draggable: true
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_signature_annotations: true
            separate_signature: true
            merge_init_into_class: true
            members_order: source
            heading_level: 2

markdown_extensions:
  - admonition
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_div_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true

nav:
  - Home: index.md
  - Tutorials:
      - Installation: tutorials/installation.md
      - Quickstart: tutorials/quickstart.md
      - Web UI: tutorials/webui.md
      - MCP Setup: tutorials/mcp-setup.md
  - How-to Guides:
      - User Guide: how-to/user_guide.md
      - Workflows: how-to/workflows.md
      - Monitoring: how-to/monitoring.md
      - Sync: how-to/sync.md
      - Web UI: how-to/webui.md
      - Settings: how-to/settings.md
      - Explorer: how-to/explorer.md
      - MCP Usage: how-to/mcp-usage.md
      - Smoke-test Notifications: how-to/smoke-test-notifications.md
  - Reference:
      - API: reference/api.md
      - Web UI API: reference/webui-api.md
      - MCP Tools: reference/mcp-tools.md
  - Explanation:
      - Architecture: explanation/architecture.md
      - MCP Architecture: explanation/mcp-architecture.md