graphiq/mkdocs.yml at main · graphiq-dev/graphiq · 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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

site_name: GraphiQ
site_description: GraphiQ - A design framework for quantum photonic circuits
site_url: https://graphiq.readthedocs.io/en/latest/
repo_url: https://github.com/graphiq-dev/graphiq
repo_name: graphiq-dev/graphiq
site_author: QBT, Ki3

copyright: Copyright &copy; 2022 - 2024 QBT, Ki3

nav:
  - Introduction:
    - Welcome: index.md
#    - Installation: installation.md
  - Tutorials:
    - Getting started: tutorials.md
    - Quantum circuits: examples/startup_guide/1_circuits.ipynb
    - Quantum states: examples/startup_guide/2_states.ipynb
    - Compiler backends: examples/startup_guide/3_compilers.ipynb
    - Noise models: examples/startup_guide/4_noise_models.ipynb
    - Objective metrics: examples/startup_guide/5_metrics.ipynb
    - Solvers & algorithms: examples/startup_guide/6_solvers.ipynb
    - Benchmarking: examples/benchmark.ipynb
#    - Variational circuits: examples/startup_guide/8_variational_circuits.ipynb
    - Visualization tools: examples/startup_guide/9_html_visualization_tutorial.ipynb
    - Parallel pipeline: examples/startup_guide/7_benchmark_pipeline.ipynb
  - How to guides:
    - Use-cases of GraphiQ: how-to-guides.md
    - Simulate a photonic circuit: examples/simulate.ipynb
    - Map target state to generating circuit: examples/evaluate.ipynb
    - Explore alternative circuits: examples/explore.ipynb
  - Reference:
      - API: reference.md
      - States: reference/states.md
      - Circuits: reference/circuit.md
      - Backends: reference/backends.md
      - Solvers: reference/solvers.md
      - Noise: reference/noise.md
      - Metrics: reference/metrics.md
      - Utilities: reference/utils.md


theme:
  name: material

  logo: img/logos/logo-mini.png
  favicon: img/logos/logo-mini.png
  icon:
    logo: logo-square.png

  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/link
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/toggle-switch-off
        name: Switch to system preference
  font:
    text: Roboto
    code: Roboto Mono


  features:
    - announce.dismiss
#    - content.action.edit
#    - content.action.view
    - content.code.annotate
    - content.code.copy
    # - content.code.select
    # - content.tabs.link
    - content.tooltips
    # - header.autohide
    # - navigation.expand
    - navigation.footer
    - navigation.indexes
    # - navigation.instant
    # - navigation.instant.prefetch
    # - navigation.instant.progress
    # - navigation.prune
    - navigation.sections
#    - navigation.tabs
    # - navigation.tabs.sticky
#    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow

plugins:
  - search:
      separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - minify:
      minify_html: true
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: sphinx
            show_root_heading: yes
  - mknotebooks:
      execute: false
      timeout: 100
      allow_errors: True
      enable_default_jupyter_cell_styling: false
      enable_default_pandas_dataframe_styling: false
#  - enumerate-headings:  # needs to be the last plugin loaded
#      toc_depth: 3
  - add-number:
      increment_topnav: true
      increment_pages: true
markdown_extensions:
  - toc:
      permalink: true
      toc_depth: 3
      baselevel: 1
      title: "Table of contents"

  # for code snippets/syntax highlighting
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences

  # for notes/admonitions
  - admonition
  - pymdownx.details

#  # for flow diagrams
#  - pymdownx.superfences:
#      custom_fences:
#        - name: mermaid
#          class: mermaid
#          format: !!python/name:pymdownx.superfences.fence_code_format

  - pymdownx.arithmatex:
      generic: 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