-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yaml
151 lines (140 loc) · 3.81 KB
/
mkdocs.yaml
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
143
144
145
146
147
148
149
150
151
site_name: neuralSPOT Edge
site_dir: "site"
site_url: "https://ambiqai.github.io/neuralspot-edge"
site_description: NeuralSPOT Edge, Keras addon targeted towards Ambiq edge SoCs
repo_name: AmbiqAI/neuralspot-edge
repo_url: https://github.com/AmbiqAI/neuralspot-edge
copyright: Copyright © 2024 Ambiq
nav:
- Home:
- Home: index.md
- Getting Started: usage/index.md
- API: api/
- Guides: guides/index.md
- Getting Started:
- usage/index.md
- API: api/
- Guides:
- guides/index.md
- Custom Model Architecture: ./guides/custom-model-architecture.ipynb
- Train CIFAR10 Model: ./guides/train-cifar-model.ipynb
theme:
name: material
favicon: assets/nse-logo-128.png
logo: assets/nse-logo-128.png
icon:
repo: fontawesome/brands/github-alt
font:
text: Roboto
code: Roboto Mono
palette:
- media: "(prefers-color-scheme)"
primary: blue
accent: indigo
toggle:
icon: material/brightness-auto
name: Use system theme
- media: "(prefers-color-scheme: light)"
scheme: default
primary: blue
accent: indigo
toggle:
icon: material/brightness-7
name: Switch to light theme
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: blue
accent: indigo
toggle:
icon: material/brightness-4
name: Switch to dark theme
features:
- content.code.annotate
- content.code.copy
- content.tooltips
- search.highlight
- search.share
- search.suggest
- toc.follow
- navigation.top
- navigation.tabs
- navigation.tabs.sticky
- navigation.prune
- navigation.path
- navigation.footer
- navigation.tracking
- navigation.instant
- navigation.instant.progress
- navigation.indexes
- navigation.expand # navigation.expand or navigation.sections
- content.tabs.link # all code tabs change simultaneously
plugins:
- search
- gen-files:
scripts:
- scripts/gen_ref_pages.py
- literate-nav:
nav_file: summary.md
- mkdocstrings:
handlers:
python:
import:
- https://docs.python.org/3/objects.inv
- https://numpy.org/doc/stable/objects.inv
options:
show_bases: false
docstring_style: google
docstring_section_style: list
line_length: 120
show_root_heading: false
heading_level: 2
merge_init_into_class: true
show_root_full_path: false
parameter_headings: true
show_symbol_type_heading: true
group_by_category: true
show_category_heading: true
modernize_annotations: true
members_order: source
filters: ["!^_", "^__init__$"]
separate_signature: true
show_signature: true
show_signature_annotations: true
show_docstring_attributes: true
show_source: true
- mkdocs-jupyter:
include_requirejs: true
include_source: true
extra_css:
- css/mkdocstrings.css
- css/termynal.css
- css/custom.css
extra_javascript:
- js/termynal.js
- js/custom.js
- https://cdn.plot.ly/plotly-2.33.0.min.js
markdown_extensions:
- admonition
- attr_list
- pymdownx.arithmatex:
generic: true
- pymdownx.details
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets:
base_path: 'docs/'
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
- pymdownx.tabbed:
alternate_style: true
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- tables
- md_in_html
- sane_lists
- pymdownx.tasklist:
custom_checkbox: true