mkdocs.yml

site_name: kirin-toolchain
repo_name: kirin-toolchain
repo_url: https://github.com/QuEraComputing/kirin
site_description: >-
  Kirin - Kernel Intermediate Representation Infrastructure
edit_uri: "edit/main/docs/"
site_url: https://special-broccoli-revrkk1.pages.github.io/

# Page tree
nav:
  - Home:
      - index.md
      - Installation: install.md
      - Declarations: def.md
      - Interpretation: interp.md
      - Analysis: analysis.md
      - Dialects:
        - Python:
          - dialects/python/index.md
          - Core: dialects/python/core.md
          - Data: dialects/python/data.md
          - Syntax Sugar: dialects/python/sugar.md
          - Special Functions: dialects/python/sfunc.md
        - Function: dialects/func.md
        - Control Flow: dialects/cf.md
        - Structural Control Flow: dialects/scf.md
        - Immutable List: dialects/ilist.md
      - Compiler 101: 101.md
      # - Comparison: comparison.md
      - Contributing: contrib.md
  - Cookbook:
    - cookbook/index.md
    - examples:
      - Food Dialect:
        - Advance Rewrite: cookbook/foodlang/cf_rewrite.md
        - Food Price Analysis: cookbook/foodlang/analysis.md
        - Recept Codegen: cookbook/foodlang/codegen.md

  - Blog:
    - blog/index.md
  - API Reference:
      - Prelude: reference/kirin/prelude.md
      - IR:
          - reference/kirin/ir/index.md
          - Nodes: reference/kirin/ir/nodes/
          - SSA values: reference/kirin/ir/ssa.md
          - Attributes: reference/kirin/ir/attrs/
          - Traits: reference/kirin/ir/traits/
          - Dialect: reference/kirin/ir/dialect.md
          - Dialect Group: reference/kirin/ir/group.md
          - Method: reference/kirin/ir/method.md
      - Interpreter: reference/kirin/interp/
      - Python Lowering: reference/kirin/lowering/
      - Analysis:
          - reference/kirin/analysis/index.md
          - CFG: reference/kirin/analysis/cfg.md
          - Call Graph: reference/kirin/analysis/callgraph.md
          - Forward Dataflow: reference/kirin/analysis/forward.md
          - Type Inference: reference/kirin/analysis/typeinfer/
          - Constant Propagation: reference/kirin/analysis/const/
      - Rewrite:
          - Generic: reference/kirin/rewrite/
          - Rules: reference/kirin/rules/
      - Method Pass: reference/kirin/passes/
      - Code Generation: reference/kirin/codegen/
      - Pretty Printing: reference/kirin/print/
      - IR declaration: reference/kirin/decl/
      - Exceptions: reference/kirin/exceptions.md
      - Data Structures:
          - Lattice: reference/kirin/lattice/abc.md
          - Graph: reference/kirin/graph.md
          - IdTable: reference/kirin/idtable.md
          - Source: reference/kirin/source.md
          - WorkList: reference/kirin/worklist.md
  - About QuEra Computing: 'https://quera.com'

theme:
  name: material
  favicon: assets/favicon.ico
  logo: assets/logo-small-white.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
              - griffe_kirin
            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: true
  - blog

extra_css:
  - stylesheets/extra.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

copyright: Copyright © 2024 Kirin 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/