mkdocs.yml

site_name : AgentRun Documentation
site_description : Documentation for the AgentRun API
site_url : "https://jonathan-adly.github.io/agentrun-docs/"
site_author : Jonathan Adly
repo_url : "https://github.com/Jonathan-Adly/AgentRun"

nav: 
  - Introduction: 
    - Welcome To AgentRun: 'index.md'
    - Help with AgentRun: 'help.md'
    - Contributing: 'contributing.md'
  
  - API Reference: api.md
  - Release Notes: release_notes.md
  - Examples: 
    - Groq: "examples/function_calling_groq.ipynb"
    - OpenAI: "examples/function_calling_openai.py"
    - llama3: "examples/llama3_groq.py"
    - Ollama: "examples/ollama_llama3.py"

theme:
  name: material
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil 
    view: material/eye
    theme:
    admonition:
      note: octicons/tag-16
      abstract: octicons/checklist-16
      info: octicons/info-16
      tip: octicons/squirrel-16
      success: octicons/check-16
      question: octicons/question-16
      warning: octicons/alert-16
      failure: octicons/x-circle-16
      danger: octicons/zap-16
      bug: octicons/bug-16
      example: octicons/beaker-16
      quote: octicons/quote-16
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - content.tabs.link
    - content.tooltips
    - header.autohide
    - navigation.expand
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.prune
    - navigation.sections
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest

  palette:
      - scheme: default
        primary: black 
        accent: indigo
        toggle:
          icon: material/brightness-7
          name: Switch to dark mode
      - scheme: slate
        primary: black
        accent: indigo
        toggle:
          icon: material/brightness-4
          name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
   
plugins:
  - search
  - mkdocstrings:
  - mkdocs-jupyter:
      ignore_h1_titles: true
      execute: false