ds4cg-job-analytics/mkdocs.yml at main · UnityHPC/ds4cg-job-analytics · 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
site_name: "Unity Job Analytics"

theme:
  name: "material"
  features:
    - navigation.tabs          # Enables horizontal top nav tabs
    - navigation.tabs.sticky   # Keeps tabs visible when scrolling
    - navigation.sections      # Groups subsections under tabs
    - toc.integrate            # Puts table of contents in main pane
  palette:
    # Palette toggle for light mode
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

plugins:
  - search
  - mkdocs-jupyter:
      include_source: true
      allow_errors: true
      ignore_h1_titles: true

  - mkdocstrings:
        handlers:
          python:

            options:
              # include type annotations in that signature
              show_signature_annotations: true
              # keep signature on the same line as the heading
              separate_signature: false
              # control how long module paths appear
              annotations_path: brief
              # choose your docstring flavor:
              docstring_style: google       # or numpy, sphinx
              # render Parameters/Returns as a table
              docstring_section_style: list

# Configure markdown extensions
markdown_extensions:
  - attr_list
  - md_in_html
  - pymdownx.arithmatex:
      generic: true

extra_javascript:
  # - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

# Suppress warnings for external links to notebooks
validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn

docs_dir: docs

nav:
  - Home: 'index.md'
  - Getting Started: 'getting-started.md'
  - Data and Efficiency Metrics: 'data-and-metrics.md'
  - Demo: 'demo.md'
  - Notebooks:
    - Efficiency Analysis: 'notebooks/Efficiency Analysis.ipynb'
    - Visualization: 'notebooks/Basic Visualization.ipynb'
    # - Frequency Analysis: 'notebooks/Frequency Analysis.ipynb'
  - Technical Documentation:
    - Data Processing: 'preprocess.md'
    - Analysis:
      - 'analysis/efficiency_analysis.md'
      - 'analysis/frequency_analysis.md'
    - Visualization:
      - 'visualization/visualization.md'
      - 'visualization/columns.md'
      - 'visualization/efficiency_metrics.md'
      - 'visualization/models.md'
    - MVP Scripts:
      - 'mvp_scripts/cpu_metrics.md'
      - 'mvp_scripts/gpu_metrics.md'
      - 'mvp_scripts/zero_gpu_usage.md'
  - FAQ: 'faq.md'
  - Contact: 'contact.md'