-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathmkdocs.yml
More file actions
128 lines (120 loc) · 3.51 KB
/
mkdocs.yml
File metadata and controls
128 lines (120 loc) · 3.51 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
site_name: QuPrep
site_description: Quantum data preparation — the missing preprocessing layer between classical datasets and quantum computing frameworks.
site_url: https://docs.quprep.org
repo_url: https://github.com/quprep/quprep
repo_name: quprep/quprep
theme:
name: material
custom_dir: docs/overrides
favicon: img/favicon.png
palette:
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: amber
toggle:
icon: material/brightness-4
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: white
accent: deep-purple
toggle:
icon: material/brightness-7
name: Switch to dark mode
font: false
icon:
repo: fontawesome/brands/github
features:
- navigation.instant
- navigation.tracking
- navigation.sections
- navigation.expand
- navigation.top
- navigation.footer
- search.suggest
- search.highlight
- content.code.copy
- content.code.annotate
- toc.follow
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/quprep/quprep
name: QuPrep on GitHub
- icon: fontawesome/brands/python
link: https://pypi.org/project/quprep/
name: QuPrep on PyPI
hooks:
- docs/hooks.py
extra_css:
- stylesheets/extra.css
extra_javascript:
- javascripts/mathjax.js
plugins:
- search
- mkdocstrings:
handlers:
python:
options:
show_source: true
show_root_heading: true
show_category_heading: true
show_symbol_type_heading: true
show_symbol_type_toc: true
docstring_style: numpy
merge_init_into_class: true
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.arithmatex:
generic: true
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- admonition
- pymdownx.details
- attr_list
- md_in_html
- toc:
permalink: true
nav:
- Home: index.md
- Getting Started:
- Installation: getting-started/installation.md
- Quickstart: getting-started/quickstart.md
- Guides:
- Encoding Guide: guides/encodings.md
- Dimensionality Reduction: guides/reduction.md
- Framework Export: guides/export.md
- QUBO / Ising: guides/qubo.md
- Validation & Cost: guides/validation.md
- Inspect & Benchmark: guides/inspect_benchmark.md
- Comparison & Fingerprinting: guides/comparison.md
- Qubit Suggestion: guides/suggest.md
- Data Drift Detection: guides/drift.md
- Plugin System: guides/plugins.md
- Data Modalities: guides/modalities.md
- Noise-Aware Preprocessing: guides/noise_aware.md
- Encoding Quality Metrics: guides/quality_metrics.md
- API Reference:
- Overview: api/index.md
- Pipeline: api/pipeline.md
- Encoders: api/encoders.md
- Exporters: api/exporters.md
- QUBO / Ising: api/qubo.md
- Validation & Cost: api/validation.md
- Comparison: api/comparison.md
- Qubit Suggestion: api/suggest.md
- Drift Detection: api/drift.md
- Modalities: api/modalities.md
- Plugin Registry: api/plugins.md
- Noise-Aware Preprocessing: api/noise_aware.md
- Quality Metrics: api/metrics.md
- Contributing: contributing.md