Repository navigation
Expand file tree
/
Copy pathmkdocs.yml
More file actions
164 lines (144 loc) · 4.34 KB
/
Copy pathmkdocs.yml
File metadata and controls
164 lines (144 loc) · 4.34 KB
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
152
153
154
155
156
157
158
159
160
161
162
163
164
site_name: "Squint"
repo_name: benjimaclellan/squint
repo_url: https://github.com/benjimaclellan/squint
copyright: Copyright © 2024-2025 Benjamin MacLellan
# use_directory_urls: true
use_directory_urls: false
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/benjimaclellan/squint
name: squint
- icon: fontawesome/solid/globe
link: https://github.com/benjimaclellan/squint
name: Documentation
nav:
- Getting started: index.md
- Quantum metrology: 'explanation/metrology.md'
- Tutorials:
- 'tutorials/one_qubit.md'
- 'tutorials/multi_qubit.md'
- 'tutorials/noise.md'
- 'tutorials/optimization.md'
- Examples:
- 'examples/1a_qubit.ipynb'
- 'examples/1b_ghz.ipynb'
- 'examples/2a_single_photon.ipynb'
- 'examples/2b_vlbi.ipynb'
- 'examples/3a_qudit.ipynb'
- 'examples/3b_xx_ising.ipynb'
# - 'examples/4a_benchmark.ipynb'
- 'examples/5a_noise.ipynb'
- Reference:
- explanation/tricks_and_tips.md
- api/base.md
# - api/circuit.md
- api/simulator.md
# - api/dv.md
# - api/fock.md
- api/ops.md
- api/math.md
- api/utils.md
# - api/distributed.md
theme:
name: material
logo: img/icon.png
favicon: img/icon.png
features:
- navigation.sections # Sections are included in the navigation on the left.
- toc.integrate # Table of contents is integrated on the left; does not appear separately on the right.
- header.autohide # header disappears as you scroll
#
- search.suggest
- search.highlight
- content.tabs.link
- content.tooltips
- content.code.annotate
- content.code.copy
- content.code.select
- navigation.tabs
- navigation.tabs.sticky
- navigation.sections
- navigation.top
- navigation.prune
- toc.follow
palette:
# Light mode / dark mode
# We deliberately don't automatically use `media` to check a user's preferences. We default to light mode as
# (a) it looks more professional, and (b) is more obvious about the fact that it offers a (dark mode) toggle.
- scheme: default
primary: white
accent: amber
toggle:
icon: material/weather-night
name: Switch to dark mode
- scheme: slate
primary: black
accent: amber
toggle:
icon: material/weather-sunny
name: Switch to light mode
plugins:
- ipynb
# - mkdocs-jupyter:
- mkdocstrings:
handlers:
python:
paths:
- ./src
options:
show_source: true
show_root_heading: false
show_root_toc_entry: false
show_symbol_type_heading: true
show_symbol_type_toc: true
show_submodules: true
docstring_style: "google"
docstring_section_style: "table"
show_signature: true
show_signature_annotations: true
signature_crossrefs: true
separate_signature: false
group_by_category: true
members_order: "source"
# import:
# - https://docs.python.org/3/objects.inv
# - https://docs.pydantic.dev/latest/objects.inv
# - https://pandas.pydata.org/docs/objects.inv
# - https://matplotlib.org/stable/objects.inv
# - https://numpy.org/doc/stable/objects.inv
markdown_extensions:
- attr_list
- toc:
permalink: true
toc_depth: 10
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
# for notes/admonitions
- pymdownx.blocks.admonition
- pymdownx.blocks.details
- pymdownx.blocks.tab:
alternate_style: true
- pymdownx.blocks.html
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.arithmatex:
generic: true
- mdx_truly_sane_lists:
nested_indent: 2
truly_sane: True
extra_javascript:
- javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
extra_css:
- stylesheets/headers.css
- stylesheets/admonitions.css
- stylesheets/custom_css.css