mkdocs.yml

site_name: "The Neutral Atom SDK"
repo_name: bloqade
repo_url: https://github.com/QuEraComputing/bloqade
site_description: >-
  Bloqade - the neutral atom SDK
edit_uri: "edit/main/docs/"
site_url: https://special-engine-kg8jlr7.pages.github.io/

# Page tree
nav:
  - Home:
      - index.md
      - Installation: install.md
      - Background: background.md
      - Quick Start:
        - Digital:
          - quick_start/digital/index.md
          - QASM2: quick_start/digital/qasm2.md
        - Analog:
          - quick_start/analog/index.md
      - Contributing: contrib.md
  - Digital Tutorial:
    - digital/index.md
    - Quantum Fourier Transform: "digital/examples/qft.py"
    - GHZ state preparation: "digital/examples/ghz.py"
    - Pauli Exponential: "digital/examples/pauli_exponentiation.py"
    - Repeat Until Success: "digital/examples/repeat_until_success.py"
    - QAOA: "digital/examples/qaoa.py"
  - Analog Tutorial: 'https://queracomputing.github.io/bloqade-python/latest/'
  - Blog:
    - blog/index.md
  - QuEra Computing: 'https://quera.com'
  # - API Reference:
  #     - QASM2: reference/bloqade/qasm2/

theme:
  name: material
  favicon: assets/favicon.ico
  logo: assets/logo-dark.svg
  palette:
    - scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - announce.dismiss
    - content.action.view
    - content.action.edit
    - content.code.annotate
    - content.code.copy
    # - content.tabs.link
    - content.tooltips
    # - header.autohide
    # - navigation.expand
    - navigation.indexes
    # - navigation.instant
    # - navigation.prune
    - navigation.sections
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - navigation.footer
    - search.highlight
    - search.suggest
    - toc.follow

plugins:
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_if_no_docstring: false
            separate_signature: true
            merge_init_into_class: true
            extensions:
              - griffe_inherited_docstrings
            show_inheritance_diagram: true
            show_signature_annotations: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            docstring_options:
              ignore_init_summary: true
  - search:
      separator: '[\s\-,:!=\[\: )"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - gen-files:
      scripts:
        - docs/scripts/gen_ref_nav.py
  - literate-nav:
      nav_file: SUMMARY.txt
  - minify:
      minify_html: false
  - blog
  - mkdocs-jupyter:
      #include: ["examples/ghz.py"]
      #ignore: []

extra_javascript:
  - javascripts/katex.js
  - https://unpkg.com/katex@0/dist/katex.min.js
  - https://unpkg.com/katex@0/dist/contrib/auto-render.min.js

extra_css:
  - stylesheets/extra.css
  - https://unpkg.com/katex@0/dist/katex.min.css

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - pymdownx.superfences
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.arithmatex:
      generic: true

copyright: Copyright © 2025 Bloqade contributors

extra:
  version:
    provider: mike
  social:
    - icon: simple/x
      link: https://x.com/QueraComputing
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/quera-computing-inc/