mkdocs.yml

# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
site_name: Bartiq
site_description: Symbolic compilation for QRE
site_author: PsiQuantum Corp.
copyright: Copyright © 2023-2024 PsiQuantum Corp.
repo_url: https://github.com/PsiQ/bartiq
repo_name: 'bartiq'
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    primary: custom
    accent: custom
  features:
    - content.code.copy
    - content.action.edit
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil
    view: material/eye
extra_css:
  - psidocs.css

nav:
  - index.md
  - installation.md
  - Tutorials:
      - tutorials/index.md
      - tutorials/01_basic_example.ipynb
      - tutorials/02_alias_sampling_basic.ipynb
  - Concepts:
      - concepts/compilation.md
      - concepts/precompilation.md
  - troubleshooting.md
  - limitations.md
  - reference.md


plugins:
  - autorefs
  - mike:
      version_selector: true
      canonical_version: latest
  - link-marker
  - open-in-new-tab
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            show_source: false
            separate_signature: true
            line_length: 60
            modernize_annotations: true
            show_signature_annotations: true
            show_root_heading: true
  - mkdocs-jupyter:
      include_source: True
  - git-revision-date-localized:
      enable_creation_date: true
      type: timeago
  - git-committers:
      repository: PsiQ/bartiq
      branch: main

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences

extra:
  version:
    provider: mike