QPyth/mkdocs.yml at main · quantumdynamics927-dotcom/QPyth · 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
site_name: QPyth
site_description: QPyth - Qiskit-based quantum toolkit for simulation, education, and research workflows
site_author: Quantum Dynamics
site_url: https://quantumdynamics.bio

docs_dir: docs
site_dir: site

repo_url: https://github.com/quantumdynamics927-dotcom/QPyth
repo_name: quantumdynamics927-dotcom/QPyth

theme:
  name: material
  custom_dir: overrides
  palette:
    - scheme: slate
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to light mode
    - scheme: default
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to dark mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.tabs.link

plugins:
  - search

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html

nav:
  - Home: index.md
  - Installation: installation.md
  - Quickstart: quickstart.md
  - Configuration: configuration.md
  - CLI Usage: cli.md
  - Web UI: web-ui.md
  - VQE: vqe.md
  - Noisy Simulation: noisy-simulation.md
  - QEC: qec.md
  - API Reference:
      - Modules: api/modules.md
      - Bloch Sphere: api/bloch.md
      - Circuits: api/circuits.md
      - VQE: api/vqe.md
      - Hardware: api/hardware.md
  - Examples:
      - Basic: examples/basic.md
      - Advanced: examples/advanced.md
  - Contributing: contributing.md
  - Testing: testing.md
  - Architecture: architecture.md