queso/mkdocs.yml at main · benjimaclellan/queso · 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

site_name: ""
site_description: Queso - Design and benchmarking of variational quantum sensors
use_directory_urls: false  # good for opening HTML files directly, but should be 'true' for deployment
site_url: https://queso.readthedocs.io/en/latest/
repo_url: https://github.com/benjimaclellan/queso
repo_name: benjimaclellan/queso
docs_dir: docs
site_author: Benjamin MacLellan

copyright: Copyright &copy; 2022 - 2024 Benjamin MacLellan


nav:
  - Introduction:
      - Welcome: index.md
  - Tutorials and guides:
      - Quantum sensing: tutorials/quantum_sensing.md
      - Sensing circuits: tutorials/sensor.ipynb
      - Circuit ansatze: tutorials/ansatze.ipynb
      - Neural network estimators: tutorials/network_estimator.ipynb
      - Bayesian inference: tutorials/bayesian_inference.ipynb

  - Reference:
      - Sensors: reference/sensors.md
      - Sampling: reference/sample.md
      - Neural networks: reference/networks.md
      - Training: reference/training.md


theme:
  name: material

  logo: imgs/logo.png
  favicon: imgs/logo-square.png
  icon:
    logo: imgs/logo.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])'
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_root_heading: yes
  - mknotebooks:
      execute: false
      timeout: 100
      allow_errors: True
      enable_default_jupyter_cell_styling: false
      enable_default_pandas_dataframe_styling: false

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