linux-benchmark-lib/mkdocs.yml at main · miciav/linux-benchmark-lib · 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
site_name: Linux Benchmark Library
repo_url: https://github.com/miciav/linux-benchmark-lib
repo_name: miciav/linux-benchmark-lib
theme:
  name: material
  logo: img/lb_mark.png
  favicon: img/lb_mark.png
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.instant
    - navigation.indexes
    - content.code.copy
    - content.action.view
  palette:
    - scheme: default
      primary: blue grey
      accent: teal
extra_css:
  - css/extra.css
nav:
  - Home: index.md
  - Getting Started:
      - Installation: installation.md
      - Quickstart: quickstart.md
  - User Guide:
      - CLI Reference: cli.md
      - Configuration: configuration.md
      - Workloads & Plugins: plugins.md
      - Remote Execution: remote_execution.md
  - API Reference:
      - Overview: api.md
      - Runner: reference/runner.md
      - Controller: reference/controller.md
      - App & UI: reference/app.md
      - Provisioning: reference/provisioner.md
      - Analytics: reference/analytics.md
  - Architecture & Design:
      - Diagrams: diagrams.md
      - Interrupts: interrupts.md
      - Ctrl+C Design: ctrl_c_design.md
      - Ctrl+C Stop Flow: ctrl_c_stop_flow.md
  - Contributing: contributing.md
plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [lb_runner, lb_controller, lb_app, lb_ui, lb_analytics, lb_plugins]
          options:
            docstring_style: google
            show_object_full_path: false
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            show_signature: true
            separate_signature: true
            show_if_no_docstring: true
            merge_init_into_class: true
            show_category_heading: true
            show_symbol_type: true
            members_order: "alphabetical"
            filters:
              - "!^_"
markdown_extensions:
  - admonition
  - attr_list
  - codehilite
  - def_list
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.tabbed
  - toc:
      permalink: true
hooks:
  - docs/mkdocs_hooks.py