QLDPC/mkdocs.yml at main · btq-ag/QLDPC · 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
site_name: QLDPC Documentation
site_description: Interactive Python Toolkit for Quantum LDPC Error Correction
site_url: https://btq-ag.github.io/QLDPC/
repo_url: https://github.com/btq-ag/QLDPC
repo_name: btq-ag/QLDPC

theme:
  name: material
  palette:
    scheme: slate
    primary: teal
    accent: green
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - content.code.copy
    - search.suggest

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
  - User Guide:
      - Circuit Builder: guide/circuit-builder.md
      - LDPC Simulator: guide/ldpc-simulator.md
      - Tanner Graph 3D: guide/tanner-graph.md
      - Threshold Landscape: guide/threshold-landscape.md
  - API Reference:
      - qldpc: api/qldpc.md
      - Components: api/components.md
      - Config: api/config.md
      - Processor: api/processor.md
      - Theme: api/theme.md
      - Simulation: api/simulation.md
      - Tanner: api/tanner.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true
            members_order: source

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

extra_javascript:
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js