-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
89 lines (81 loc) · 2.81 KB
/
mkdocs.yml
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
site_name: QUAlibrate Documentation
# site_url:
site_author: QM. Technologies Ltd.
# site_description:
copyright: Copyright © 2024 Q.M Technologies Ltd.
theme:
name: material
logo: assets/logo.png
font:
text: Roboto
code: Roboto Mono
favicon: assets/logo.png
palette:
- scheme: qualibrate-bright
toggle:
icon: material/brightness-7
name: Switch to high contrast mode
- scheme: qualibrate-high-contrast
toggle:
icon: material/brightness-6
name: Switch to dark mode
- scheme: qualibrate-dark
toggle:
icon: material/brightness-5
name: Switch to light mode
features:
# - navigation.tabs # Add tabs to the top of the page
# - navigation.sections # Expand sections in the navigation
- navigation.top # Add "back to top" button when scrolling back up
- toc.integrate # Include TOC in left sidebar instead of separate right
- search.suggest
- search.highlight
- content.tabs.link
- content.code.annotations
- content.code.copy
- content.code.annotate # Add annotations to code blocks
language: en
extra_css:
- stylesheets/extra.css
nav:
- index.md
- installation.md
- calibration_nodes.md
- calibration_library.md
- calibration_graphs.md
- web_app.md
- configuration.md
# - "API References":
# - "API_references/index.md"
# - "QuAM Components":
# - "QuAM Channels API": "API_references/components/channels_API.md"
# - "QuAM Pulses API": "API_references/components/pulses_API.md"
# - "QuAM Hardware API": "API_references/components/hardware_API.md"
# - "QuAM Octave API": "API_references/components/octave_API.md"
# - "BasicQuAM API": "API_references/components/basic_quam_API.md"
# - "QuAM Core Classes API": "API_references/core/quam_classes_API.md"
plugins:
# - mkdocs-jupyter:
# include:
# - "*.ipynb"
- search
# - autorefs # Automatically link across pages
# - gen-files: # Autogenerate code reference using mkdocstrings
# scripts:
# - docs/gen_ref_pages.py
# - mkdocstrings:
# default_handler: python
# handlers:
# python:
# paths: [qualibrate]
markdown_extensions:
- admonition # Add info / warning blocks
- md_in_html # Add markdown within html <div> tags
- pymdownx.blocks.tab: # Add tabs to markdown using: === "title"
alternate_style: true # Somehow this is required for tabs to work
- pymdownx.blocks.details # Enable collapsible elements, e.g.: ??? tip "title"
- pymdownx.superfences # Enable multiline code in tabs
- attr_list # allows to add HTML attributes and CSS classes to almost every Markdown inline- and block-level element with a special syntax.
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg