mkdocs.yml

site_name: Qadence 2 expressions
repo_url: "https://github.com/pasqal-io/qadence2-expressions"
repo_name: "qadence2_expressions"

nav:
  - Home: index.md

  - Getting started:
    - Installation: getting_started/installation.md
    - Development & Info:
      - Contributing: getting_started/CONTRIBUTING.md
      - Code of conduct: getting_started/CODE_OF_CONDUCT.md
      - License: getting_started/LICENSE.md

  - Contents:
    - Expression system: contents/expression_system.md
    - IR compilation: contents/ir_compilation.md
    - Useful functions: contents/useful_functions.md

  - Tutorials:
    - tutorials/index.md

  - API:
    - Expression: api/expressions.md
    - Environment: api/environment.md
    - Constructors: api/constructors.md
    - Support: api/support.md

theme:
  name: material
  custom_dir: docs/extras/overrides/
  features:
  - content.code.annotate
  - content.action.view
  - content.action.edit
  - navigation.tabs
  - navigation.indexes
  - navigation.sections
  - content.code.copy

  palette:
  - media: "(prefers-color-scheme: light)"
    scheme: default
    primary: light green
    accent: purple
    toggle:
      icon: material/weather-sunny
      name: Switch to dark mode
  - media: "(prefers-color-scheme: dark)"
    scheme: slate
    primary: black
    accent: light green
    toggle:
      icon: material/weather-night
      name: Switch to light mode

markdown_extensions:
- admonition  # for notes
- footnotes
- pymdownx.arithmatex: # for mathjax
    generic: true
- pymdownx.highlight:
    anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences:
    custom_fences:
    - name: python
      class: python
      validator: "!!python/name:markdown_exec.validator"
      format: "!!python/name:markdown_exec.formatter"


plugins:
- search
- section-index
- markdown-exec
- mkdocstrings:
    default_handler: python
    handlers:
      python:
        selection:
          filters:
            - "!^_"  # exlude all members starting with _
            - "^__init__$"  # but always include __init__ modules and methods
        options:
          show_root_toc_entry: false
          heading_level: 3
          merge_init_into_class: true
          docstring_section_style: spacy

watch:
  - qadence2_expressions

extra:
 version:
   provider: mike

# To get nice tabs
extra_css:
  - extras/css/mkdocstrings.css
  - extras/css/colors.css
  - extras/css/home.css

# For mathjax
extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js