mkdocs.yml

site_name: llama-cpp-agent
repo_url: https://github.com/Maximilian-Winter/llama-cpp-agent

theme:
  name: material
  palette: 

    # Palette toggle for light mode
    - scheme: default
      primary: indigo
      toggle:
        icon: material/brightness-7 
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      primary: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            members_order: source
            group_by_category: false
            signature_crossrefs: true
            show_signature: true
            docstring_section_style: list
            show_root_heading: true
            heading_level: 3
            preload_modules:
              - typing
              - typing_extensions
              - ctypes
          import:
            - https://docs.python.org/3/objects.inv
            - https://numpy.org/doc/stable/objects.inv

watch:
  - src/llama_cpp_agent
  - ReadMe.md

nav:
  - "Welcome": "index.md"
  - "Getting Started": "get-started.md"
  - "Guides":
      "Simple Chat": "simple-chat-example.md"
      "Function Calling Agent": "function-calling-agent.md"
      "Parallel Function Calling Agent": "parallel_function_calling.md"
      "Structured Output Agent": "structured-output-example.md"
      "RAG- Retrieval Augmented Generation": "rag.md"
      "llama-index tools example": "llama_index_tool_use.md"
      "Sequential Chain Example": "sequential_chain.md"
      "Map Chain Example": "map_chain.md"
      "Manual Function Calling Example": "manual-function-calling.md"
      "Manual Function Calling Example With Python Function": "manual_function_calling_with_python_function.md"
      "Knowledge Graph Generation": "knowledge-graph-example.md"


  - "API Reference":
      "Provider": "provider-api-reference.md"
      "Agents": "agents-api-reference.md"
      "Chat History": "chat_history-api-reference.md"
      "Function Calling": "function-calling-api-reference.md"
      "Agent Chains": "agent_chains.md"
      "Output Parsing": "output-parser-api-reference.md"
      "Grammar Generator": "grammar-api-reference.md"

markdown_extensions:
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: abetlen
      repo: llama-cpp-python
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true 
  - pymdownx.tilde
  - tables