MQSS-Qiskit-Adapter/mkdocs.yml at develop · mdepasca-mqv/MQSS-Qiskit-Adapter · 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
site_name: MQSS Qiskit Adapter Documentation

docs_dir: "docs"
site_dir: build/docs/site
use_directory_urls: true
dev_addr: "0.0.0.0:8000"
watch:
  - docs
  - mkdocs.yml

nav:
  - MQSS Interfaces: https://munich-quantum-software-stack.github.io/MQSS-Interfaces/
  - Home: index.md
  - User Guide:
      - Getting Started: user_guide/getting_started.md
      - Development Guide: user_guide/development_guide.md
  - API Documentation:
      - MQSSQiskitAdapter: api/mqss_adapter.md
      - MQSSQiskitBackend: api/mqss_backend.md
      - MQSSQiskitJob: api/mqss_job.md
  - Change Log: CHANGELOG.md
  - Contact Us: contact.md

theme:
  name: material
  logo: img/mqss_logo_white.svg
  palette:
    # Light Mode
    - scheme: default
      toggle:
        icon: material/lightbulb-night-outline
        name: Light mode
      primary: custom
      accent: deep purple

    # Dark Mode
    - scheme: slate
      toggle:
        icon: material/lightbulb-on-outline
        name: Dark mode
      primary: indigo
      accent: deep orange
  features:
    - content.code.copy
    - navigation.instant
    - navigation.footer

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: false
            separate_signature: true
            show_if_no_docstring: false
            show_root_full_path: true
            show_signature_annotations: true
  - autorefs

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - codehilite
  - footnotes
  - meta
  - toc:
      permalink: true

extra_css:
  - css/extra.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Munich-Quantum-Software-Stack/MQSS-Qiskit-Adapter
    - icon: fontawesome/solid/envelope
      link: mailto:quantum@lrz.de

copyright: Copyright &copy; 2025 MQV