OpenSquirrel/mkdocs.yaml at develop · QuTech-Delft/OpenSquirrel · 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
site_name: OpenSquirrel
site_dir: public
repo_url: https://github.com/QuTech-Delft/OpenSquirrel
use_directory_urls: false

nav:
  - Home:
    - Home: index.md
    - Installation: installation.md
    - Contributing: contributing.md
    - Authors: authors.md
    - Acknowledgements: acknowledgements.md
  - Tutorial:
    - Tutorial: tutorial/index.md
    - Creating a circuit: tutorial/creating-a-circuit.md
    - Applying compilation passes: tutorial/applying-compilation-passes.md
    - Writing out and exporting: tutorial/writing-out-and-exporting.md
  - Circuit builder:
    - Circuit builder: circuit-builder/index.md
    - Instructions:
        - Gates: circuit-builder/instructions/gates.md
        - Non-unitaries: circuit-builder/instructions/non-unitaries.md
        - Control instructions: circuit-builder/instructions/control-instructions.md
  - Compilation passes:
    - Compilation passes: compilation-passes/index.md
    - Decomposition:
      - Decomposition: compilation-passes/decomposition/index.md
      - ABA decomposer: compilation-passes/decomposition/aba-decomposer.md
      - CNOT decomposer: compilation-passes/decomposition/cnot-decomposer.md
      - CZ decomposer: compilation-passes/decomposition/cz-decomposer.md
      - McKay decomposer: compilation-passes/decomposition/mckay-decomposer.md
      - Predefined decomposers: compilation-passes/decomposition/predefined-decomposers.md
    - Exporting:
      - Exporting: compilation-passes/exporting/index.md
      - cQASMv1 exporter:  compilation-passes/exporting/cqasm-v1-exporter.md
      - quantify-scheduler exporter:  compilation-passes/exporting/quantify-scheduler-exporter.md
    - Mapping:
      - Mapping: compilation-passes/mapping/index.md
      - Hardcoded mapper: compilation-passes/mapping/hardcoded-mapper.md
      - Identity mapper: compilation-passes/mapping/identity-mapper.md
      - Random mapper: compilation-passes/mapping/random-mapper.md
      - QGym mapper: compilation-passes/mapping/qgym-mapper.md
    - Merging:
      - Merging: compilation-passes/merging/index.md
      - Single-qubit gates merger: compilation-passes/merging/single-qubit-gates-merger.md
    - Routing:
      - Routing: compilation-passes/routing/index.md
      - A* router: compilation-passes/routing/a-star-router.md
      - Shortest-path router: compilation-passes/routing/shortest-path-router.md
    - Validation:
      - Validation: compilation-passes/validation/index.md
      - Interaction validator: compilation-passes/validation/interaction-validator.md
      - Primitive gate validator: compilation-passes/validation/primitive-gate-validator.md
  - API documentation: reference/

theme:
  name: "material"
  features:
    - navigation.indexes
    - navigation.tabs
    - navigation.tracking
    - navigation.footer
    - content.code.copy
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

markdown_extensions:
  - attr_list
  - admonition
  - def_list
  - footnotes
  - md_in_html
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - tables

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

plugins:
  - gen-files:
      scripts:
        - scripts/gen_reference_page.py
  - literate-nav:
      nav_file: reference.md
  - autorefs
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_bases: true
            show_signature: true
            separate_signature: true
            show_signature_annotations: true
  - glightbox
  - search