daqiri/mkdocs.yml at main · NVIDIA/daqiri · 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
site_name: "DAQIRI: Data Acquisition for Integrated Real-time Instruments"
site_url: https://nvidia.github.io/daqiri/
repo_url: https://github.com/nvidia/daqiri
repo_name: nvidia/daqiri

theme:
  name: material
  custom_dir: overrides
  logo: images/logo.svg
  favicon: images/favicon-32.png
  palette:
    - scheme: slate
      primary: black
      accent: light green
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      primary: black
      accent: light green
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  font:
    text: Inter
    code: JetBrains Mono
  icon:
    repo: fontawesome/brands/github
  features:
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.footer
    - search.highlight
    - search.suggest
    - toc.follow

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/platform-tab-toc.js
  - javascripts/tab-dropdowns.js
  - javascripts/image-overlay.js

site_dir: site
exclude_docs: |
  landing/
  images/packet_diagrams/README.md

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Concepts: concepts.md
  - Benchmarking:
    - Overview: benchmarks/index.md
    - Socket and RDMA Benchmarking: benchmarks/socket_benchmarking.md
    - Raw Ethernet Benchmarking: benchmarks/raw_benchmarking.md
    - "Performance: DGX Spark": benchmarks/performance-dgx-spark.md
  - API Reference:
    - API Guide: api-reference/index.md
    - Configuration YAML Reference: api-reference/configuration.md
    - C++ API Usage: api-reference/cpp.md
    - Python API Usage: api-reference/python.md
  - Tutorials:
    - System Configuration: tutorials/system_configuration.md
    - Bare-Metal CMake Build: tutorials/bare-metal-cmake-build.md
    - Configuration YAML Walkthrough: tutorials/configuration-walkthrough.md
    - DAQIRI + Holoscan Integration: tutorials/daqiri-holoscan-integration.md

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path:
        - docs
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

docs_dir: docs

validation:
  nav:
    omitted_files: warn
    not_found: warn
    absolute_links: warn
  links:
    not_found: warn
    absolute_links: warn
    unrecognized_links: warn
    anchors: warn

hooks:
  - hooks/nav_dropdowns.py

plugins:
  - search