microsoft--agent-lightning/mkdocs.yml

site_name: Agent-lightning
site_url: https://microsoft.github.io/agent-lightning/
repo_url: https://github.com/microsoft/agent-lightning
repo_name: agent-lightning

theme:
  name: material
  custom_dir: docs/overrides
  logo: assets/favicon-white.svg
  favicon: assets/favicon.svg
  palette:
    - scheme: default
      primary: agl
      accent: agl
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: agl
      accent: agl
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.snippets
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.arithmatex:
      generic: true
      inline_syntax: ["round"]
      block_syntax: ["block"]
  - toc:
      permalink: true
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
  - search
  - git-revision-date-localized:
      enable_creation_date: true
      type: timeago
  - git-authors
  - macros:
      module_name: docs/macros/source_links
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: false
            show_root_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            docstring_section_style: list
            docstring_style: google
            heading_level: 3
  - autorefs
  - mike:
      version_selector: true
      css_dir: css
      javascript_dir: js
      canonical_version: latest

extra:
  version:
    provider: mike
    default: stable
  source_commit: !ENV [SOURCE_COMMIT, 'main']

extra_javascript:
  - https://unpkg.com/mermaid@10.6.1/dist/mermaid.min.js
  - https://unpkg.com/chart.js@4.5.1/dist/chart.umd.min.js
  - https://unpkg.com/katex@0/dist/katex.min.js
  - https://unpkg.com/katex@0/dist/contrib/auto-render.min.js
  - javascripts/charts.js
  - javascripts/move-source-file.js
  - javascripts/katex.js

nav:
  - Home: index.md
  - Quickstart:
    - Installation: tutorials/installation.md
    - Train the First Agent: how-to/train-first-agent.md
    - Write the First Algorithm: how-to/write-first-algorithm.md
  - How-To Recipes:
    - Examples Catalog: how-to/examples-catalog.md
    - SFT with Unsloth: how-to/unsloth-sft.md
    - Train SQL Agent with RL: how-to/train-sql-agent.md
  - Learning More:
    - Write Agents: tutorials/write-agents.md
    - Debugging: tutorials/debug.md
    - Work with Traces: tutorials/traces.md
    - Use Emitters: tutorials/emitter.md
    - Parallelize: tutorials/parallelize.md
  - Algorithm Zoo:
    - Overview: algorithm-zoo/index.md
    - APO: algorithm-zoo/apo.md
    - VERL: algorithm-zoo/verl.md
  - Deep Dive:
    - Bird's Eye View: deep-dive/birds-eye-view.md
    - Understanding Store: deep-dive/store.md
    - Serving LLM: deep-dive/serving-llm.md
  - API References:
    - Agent: reference/agent.md
    - Algorithm: reference/algorithm.md
    - Command Line: reference/cli.md
    - Instrumentation: reference/instrumentation.md
    - Runner: reference/runner.md
    - Semantic Conventions: reference/semconv.md
    - Store: reference/store.md
    - Trainer: reference/trainer.md
    - Types: reference/types.md
    - RESTful: reference/restful.md
    - Utilities: reference/utilities.md
    - Internal: reference/internal.md
  - Miscellaneous:
    - Contributing Guide: community/contributing.md
    - Maintainer Guide: community/maintainers.md
    - Changelog: changelog.md

extra_css:
  - https://unpkg.com/katex@0/dist/katex.min.css
  - stylesheets/extra.css