brainsmith/mkdocs.yml at main · microsoft/brainsmith · 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
134
135
136
137
138
139
140
141
142
site_name: Brainsmith
site_description: From PyTorch to RTL - FPGA Accelerator Compiler for AI
site_author: Microsoft
site_url: https://microsoft.github.io/brainsmith/

repo_name: microsoft/brainsmith
repo_url: https://github.com/microsoft/brainsmith
edit_uri: edit/main/docs/

copyright: Copyright &copy; Microsoft. All rights reserved.

theme:
  name: material
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

  features:
    - navigation.instant      # Fast page loads
    - navigation.top          # Back to top button
    - navigation.indexes      # Section index pages
    - search.suggest          # Search suggestions
    - search.highlight        # Highlight search terms
    - content.code.copy       # Copy button for code blocks

  icon:
    repo: fontawesome/brands/github

use_directory_urls: true

# Exclude files from build
exclude_docs: |
  kernels/_template.md
  api/_template.md
  developer-guide/experimental/

plugins:
  - search
  - glightbox:
      touchNavigation: true
      loop: false
      effect: zoom
      width: 100%
      zoomable: true
      draggable: true
      auto_caption: false
      caption_position: bottom
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            show_signature_annotations: true
            separate_signature: true
            merge_init_into_class: true
            heading_level: 2
  - git-revision-date-localized:
      enable_creation_date: true
      type: timeago

markdown_extensions:
  # Code highlighting
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

  # Content features
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true
  - tables

  # Navigation
  - toc:
      permalink: true
      toc_depth: 3

  # Typography
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Developer Guide:
    - Overview: developer-guide/index.md
    - Hardware Kernels: developer-guide/hardware-kernels.md
    - Component Registry: developer-guide/registry.md
    - Blueprint Schema: developer-guide/blueprint-schema.md
    - Dataflow Modeling: developer-guide/dataflow-modeling.md
    - Multi-Layer Offload: developer-guide/multi-layer-offload.md
  - API Reference:
    - Overview: api/index.md
    - CLI: api/cli.md
    - Design Space Exploration: api/dse.md
    - Dataflow Modeling: api/dataflow.md
    - Component Registry: api/registry.md
    - Settings: api/settings.md
  - Tutorials (Coming Soon): tutorials/index.md

extra_css:
  - stylesheets/extra.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/microsoft/brainsmith
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/brainsmith/
  version:
    provider: mike