mkdocs.yml

site_name: polars-bio
site_url: https://biodatageeks.org/polars-bio/
repo_url: https://github.com/biodatageeks/polars-bio
repo_name: biodatageeks/polars-bio
nav:
  - Home:
      - polars-bio: index.md
      - 🏃🏼‍♂️ Quick start: quickstart.md
      - 🔨Features: features.md
      - 📚 Tutorial: notebooks/tutorial.ipynb
      - 🚀 Performance: performance.md
      - ⚙️ API reference: api.md
  - Quick start: quickstart.md
  - Features: features.md
  - Tutorial: notebooks/tutorial.ipynb
  - Performance: performance.md
  - API reference: api.md

plugins:
  - search
  - autorefs
  - mkdocs-jupyter:
      execute: true
      allow_errors: false
  - mkdocstrings:
      default_handler:
      python:
        options:
          docstring_style: google
theme:
  name: material
  logo: assets/logo.png
  favicon: assets/logo.png
  features:
    - content.code.copy
    - content.code.select
    - content.code.annotate
    - content.tabs.link
    - content.action.edit
    - content.tooltips
    - toc.follow
    - navigation.top
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.footer
    - navigation.tracking
    - navigation.instant
    - content.footnote.tooltips
  icon:
    repo: fontawesome/brands/github
extra:
  version:
    provider: mike
    default:
      - latest

markdown_extensions:
  - admonition
  - footnotes
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path: ..
      dedent_subsections: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - md_in_html
  - abbr
  - attr_list
  - pymdownx.snippets
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - markdown.extensions.toc:
      baselevel: 1
      permalink: ""