quantum_stochastic_programming/mkdocs.yml at main · NatLabRockies/quantum_stochastic_programming · 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
site_name: Quantum Stochastic Programming
site_description: Quantum algorithms for two-stage stochastic unit commitment — DQA + QAE
site_url: https://nileshsawant.github.io/quantum_stochastic_programming
repo_url: https://github.com/nileshsawant/quantum_stochastic_programming
repo_name: nileshsawant/quantum_stochastic_programming
edit_uri: edit/gpuOptim/docs/

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.highlight
    - search.suggest
    - content.code.copy
    - toc.integrate

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths:
            - .
            - qiskit_impl
            - QuantumExpectedValueFunctionProject
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_category_heading: true
            show_signature_annotations: true
            members_order: source
            separate_signature: true
            merge_init_into_class: true
            show_submodules: false

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - md_in_html
  - tables
  - footnotes
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true

extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

nav:
  - Home: index.md
  - Algorithm Overview: algorithm.md
  - API Reference:
    - qiskit_impl/:
      - binary_optimizer: api/binary_optimizer.md
      - cudaq_impl: api/cudaq_impl.md
      - qae: api/qae.md
      - ExpValFun_functions: api/expvalfun_functions.md
      - dist_prep: api/dist_prep.md
      - resource_estimator: api/resource_estimator.md
    - QuantumExpectedValueFunctionProject/:
      - optimizer_utils: api/optimizer_utils.md
      - dense_optimizer: api/dense_optimizer.md
      - expanded_optimizer: api/expanded_optimizer.md
  - GPU Porting Guide: gpu_porting.md
  - References: references.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/nileshsawant