LeeQ/mkdocs.yml at main · ShuxiangCao/LeeQ · 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
site_name: LeeQ Documentation
site_description: Quantum computing experiment orchestration framework
site_url: https://leeq.readthedocs.io

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - search.highlight
    - content.code.copy
  palette:
    - scheme: default
      primary: indigo
      accent: indigo

plugins:
  - search

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: quick_start.md
    - Tutorial: tutorial.md
  - User Guide:
    - Core Concepts: guide/concepts.md
    - Experiments: guide/experiments.md
    - Calibrations: guide/calibrations.md
  - API Reference:
    - Core:
      - Base: api/core/base.md
      - Elements: api/core/elements.md
      - Engine: api/core/engine.md
      - Primitives: api/core/primitives.md
    - Experiments:
      - Builtin: api/experiments/builtin.md
      - Custom: api/experiments/base.md
    - Theory:
      - Simulation: api/theory/simulation.md
      - Tomography: api/theory/tomography.md
      - Optimal Control: api/theory/fits.md
      - Clifford Gates: api/theory/clifford.md
    - Compiler:
      - LBNL QubiC: api/compiler/lbnl_qubic.md
      - Base Classes: api/compiler/base.md
  - Development:
    - Contributing: development/contributing.md
    - Testing: development/testing.md
    - Architecture: development/architecture.md
  - EPII:
    - Overview: epii/overview.md
    - Deployment Guide: epii/deployment-guide.md
    - Client Usage: epii/client-usage.md
    - Operations Guide: epii-operations-guide.md
    - Quick Reference: epii/quick-reference.md
    - Troubleshooting: epii/troubleshooting.md
    - API Reference:
      - Overview: api/epii/overview.md
      - Experiments: api/epii/experiments.md
      - Service: api/epii/service.md

markdown_extensions:
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.arithmatex:
      generic: true
  - admonition
  - toc:
      permalink: true