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://bloqade.quera.com/

# Page tree
nav:
  - Home:
      - index.md
      - Installation: install.md
      - Background: background.md
      - Manifesto: manifesto.md
      - Quick Start:
        - Bloqade Digital:
          - quick_start/circuits/index.md
        - Bloqade Analog:
          - quick_start/analog/index.md
      - Contributing: contrib.md
  - Bloqade Digital:
    - digital/index.md
    - Domain specific languages: digital/dialects_and_kernels/
    - Compilation process: digital/compilation.md
    - Simulation: digital/simulator_device/
    - Interoperability with Cirq: digital/cirq_interop/
  - Digital Tutorials:
    - digital/examples/index.md
    - Tutorials:
      - Circuits with Bloqade: "digital/tutorials/circuits_with_bloqade.py"
      - Automatic parallelism: "digital/tutorials/auto_parallelism.py"
    - QASM2 examples:
      - Quantum Fourier Transform: "digital/examples/qasm2/qft.py"
      - GHZ state preparation: "digital/examples/qasm2/ghz.py"
      - Pauli Exponential: "digital/examples/qasm2/pauli_exponentiation.py"
      - Repeat Until Success: "digital/examples/qasm2/repeat_until_success.py"
      - QAOA: "digital/examples/qasm2/qaoa.py"
    - Squin dialect examples:
      - Deutsch-Jozsa Algorithm: digital/examples/squin/deutsch_squin.py
      - GHZ state preparation with noise: digital/examples/squin/ghz.py
    - TSIM examples:
      - Magic state distillation: digital/examples/tsim/magic_state_distillation.py
    - Gemini Logical dialect examples:
      - Demonstration of Simulator Device: digital/examples/gemini_logical/simulator_device_demo.py
    - Integration with other SDKs:
      - Noisy GHZ states with cirq: "digital/examples/interop/noisy_ghz.py"
  - Bloqade Analog:
      - analog/index.md
      - Migration Guide to Bloqade Analog: analog/home/migration.md
      - Quickstart: analog/home/quick_start.md
      - Background: analog/home/background.md
      - Gotchas: analog/home/gotchas.md
      - Contributing: analog/contributing/
      - Builder:
        - analog/reference/overview.md
        - analog/reference/standard.md
      - Hardware Reference: analog/reference/hardware-capabilities.md
  - Analog Tutorials: 'https://queracomputing.github.io/bloqade-analog-examples/dev/'
  - qBook: 'https://qbook.quera.com/'
  - API Reference:
    - 'reference/index.md'
    - Bloqade Digital: 'reference/bloqade-circuit/src/bloqade/'
    - Bloqade Lanes: 'reference/bloqade-lanes/python/bloqade/'
    - Bloqade Analog: 'reference/bloqade-analog/src/bloqade/analog/'
  - Blog:
    - blog/index.md
  - QuEra Computing: 'https://quera.com'

theme:
  name: material
  favicon: assets/favicon.ico
  logo: assets/logo-dark.svg
  font:
    text: Lato
  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:
  - autorefs
  - mkdocstrings:
      handlers:
        python:
          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_BLOQADE_CIRCUIT.md
  - minify:
      minify_html: false
  - blog:
      post_excerpt_max_authors: 5
  - mkdocs-jupyter:
      execute: !ENV ["EXECUTE_NOTEBOOKS", true]
      allow_errors: false
      execute_ignore: ["scripts/*", "digital/examples/qasm2/*"]
  - mike

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:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

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/