messy/mkdocs.yaml at main · eml-eda/messy · 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
# Copyright 2020 ETH Zurich and University of Bologna.
# Licensed under the Apache License, Version 2.0, see LICENSE for details.
# SPDX-License-Identifier: Apache-2.0

site_name: MESSY
repo_url: https://github.com/eml-eda/messy
repo_name: eml-eda/messy
theme:
  name: material
  features:
    - content.code.copy
    - content.code.annotate
  icon:
    admonition:
      note: octicons/tag-16
      abstract: octicons/checklist-16
      info: octicons/info-16
      tip: octicons/squirrel-16
      success: octicons/check-16
      question: octicons/question-16
      warning: octicons/alert-16
      failure: octicons/x-circle-16
      danger: octicons/zap-16
      bug: octicons/bug-16
      example: octicons/beaker-16
      quote: octicons/quote-16
  icon:
    repo: fontawesome/brands/github
  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
markdown_extensions:
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

nav:
  - Overview: index.md
  - "Getting Started":
    - "What is MESSY": what-is-messy.md
    - "Installation and Setup": getting-started.md
    - "Usage": how-to-build-docs.md
  - "Examples":
    - "Hello World": examples/hello-world.md
    - "Periodic Sensor": examples/periodic-sensor.md
    - "Read Sensor": examples/read-sensor.md
    - "Read Write Multiple Sensors": examples/read-write-multiple-sensors.md
    - "Read Write Sensor": examples/read-write-sensor.md
  - "Core Concepts":
    - "Flow": flow.md
    - "Codegen": codegen.md
    - "Timing and Communication": timing.md
    - "SystemC Modules Timing": communication-example.md
    - "IPXACT": ipxact.md
    - "IPXACT Parsing": ipxact-parsing.md
    - "Building Blocks":
      - "Core": core.md
      - "Functional Bus": functional-bus.md
      - "Power Bus": power-bus.md
      - "Sensors": sensors.md
      - "Adapter": adapter.md
      - "Harvesters": harvesters.md
      - "Converters": converters.md
      - "LUT": lut.md
  - "Utilities and Advanced Topics":
    - "Docker": docker.md
    - "Resolution": resolution.md
    - "Debugging": debugging.md
    - "Tracing": tracing.md