langgraph/docs/mkdocs.yml

site_name: LangGraph
site_description: Build language agents as graphs
site_url: https://langchain-ai.github.io/langgraph/
theme:
  name: material
  custom_dir: overrides
  logo: static/wordmark.png
  favicon: static/favicon.png
  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
    - toc.follow
  palette:
  - scheme: default
    primary: white
    accent: gray
    toggle:
      icon: material/brightness-7
      name: Switch to dark mode
  - scheme: slate
    primary: grey
    accent: white
    toggle:
      icon: material/brightness-4
      name: Switch to light mode
  font:
    text: "Public Sans"
    code: "Roboto Mono"
plugins:
  - search:
      separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - autorefs
  - mkdocstrings:
      handlers:
        python:
          import:
            - https://docs.python.org/3/objects.inv
            - https://api.python.langchain.com/en/latest/objects.inv
          options:
            members_order: source 
            allow_inspection: true
            heading_level: 3
            show_bases: true
            summary: true
            inherited_members: true
            # merge_init_into_class: true
            selection:
                docstring_style: google
            docstring_section_style: list
            show_root_toc_entry: false 
            # show_signature_annotations: true
            # show_symbol_type_heading: true
            show_symbol_type_toc: true
            signature_crossrefs: true
  - mkdocs-jupyter:
      ignore_h1_titles: true
      execute: false
      include_source: True
      include_requirejs: true
  # TODO: Add minify plugin once it works alright with code block copying
  # - minify:
  #     minify_html: true
nav:
  - Home: 
      - 'index.md'
      - Quick Start: how-tos/docs/quickstart.ipynb
      - Intro to LangGraph: tutorials/introduction.ipynb
  - Tutorials:
      - 'tutorials/index.md'
      - Introduction: tutorials/introduction.ipynb
      - Use cases:
          - Chatbots:
              - Customer Support: tutorials/customer-support/customer-support.ipynb
              - Info Gathering: tutorials/chatbots/information-gather-prompting.ipynb
              - Code Assistant: tutorials/code_assistant/langgraph_code_assistant.ipynb
          - Multi-Agent Systems:
              - Collaboration: tutorials/multi_agent/multi-agent-collaboration.ipynb
              - Supervision: tutorials/multi_agent/agent_supervisor.ipynb
              - Hierarchical Teams: tutorials/multi_agent/hierarchical_agent_teams.ipynb
          - RAG:
              - tutorials/rag/langgraph_adaptive_rag.ipynb
              - tutorials/rag/langgraph_adaptive_rag_cohere.ipynb
              - tutorials/rag/langgraph_adaptive_rag_local.ipynb
              - tutorials/rag/langgraph_agentic_rag.ipynb
              - tutorials/rag/langgraph_crag.ipynb
              - tutorials/rag/langgraph_crag_local.ipynb
              - tutorials/rag/langgraph_self_rag.ipynb
              - tutorials/rag/langgraph_self_rag_local.ipynb
          - Web Research (STORM): tutorials/storm/storm.ipynb
          - Planning Agents:
              - Plan-and-Execute: tutorials/plan-and-execute/plan-and-execute.ipynb
              - Reasoning w/o Observation: tutorials/rewoo/rewoo.ipynb
              - LLMCompiler: tutorials/llm-compiler/LLMCompiler.ipynb
          - Reflection & Critique:
              - Basic Reflection: tutorials/reflection/reflection.ipynb
              - Reflexion: tutorials/reflexion/reflexion.ipynb
              - Language Agent Tree Search: tutorials/lats/lats.ipynb
              - Self-Discovering Agent: tutorials/self-discover/self-discover.ipynb
          - Evaluation & Analysis:
              - Chatbot Eval via Sim:
                  - Agent-based: tutorials/chatbot-simulation-evaluation/agent-simulation-evaluation.ipynb
                  - In LangSmith: tutorials/chatbot-simulation-evaluation/langsmith-agent-simulation-evaluation.ipynb
          - Web Navigation: tutorials/web-navigation/web_voyager.ipynb
          - Competitive Programming: tutorials/usaco/usaco.ipynb

  - "How-to Guides":
     - 'how-tos/index.md'
     - Core:
         - "Persistence": how-tos/persistence.ipynb
         - "Time Travel": how-tos/time-travel.ipynb 
         - "Async Execution": how-tos/async.ipynb
         - "Streaming Responses": how-tos/streaming-tokens.ipynb
         - "Visualization": how-tos/visualization.ipynb
         - "Configuration": how-tos/configuration.ipynb
     - Design Patterns:
         - "Subgraphs": how-tos/subgraph.ipynb
         - "Branching": how-tos/branching.ipynb
         - "Human-in-the-Loop": how-tos/human-in-the-loop.ipynb
         - "Force Calling a Tool First": how-tos/force-calling-a-tool-first.ipynb
         - "Dynamic Direct Return": how-tos/dynamically-returning-directly.ipynb
         - "Respond in Structured Format": how-tos/respond-in-format.ipynb
         - "Managing Agent Steps": how-tos/managing-agent-steps.ipynb
     - Alternative State Definitions:  
         - "Pydantic State": how-tos/state-model.ipynb
     - Structured Output:
         - "Extraction with Re-prompting": how-tos/extraction/retries.ipynb
  - 'Conceptual Guides':
     - 'concepts/index.md'
  - Reference:
      - Graphs: reference/graphs.md
      - Checkpointing: reference/checkpoints.md
      - Prebuilt Components: reference/prebuilt.md
      - Errors: reference/errors.md    
  

markdown_extensions:
  - abbr
  - admonition
  - pymdownx.details
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      use_pygments: true
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      normalize_issue_symbols: true
      repo_url_shorthand: true
      user: langchain-ai 
      repo: langgraph
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      auto_append:
        - includes/mkdocs.md
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
  - pymdownx.tasklist:
      custom_checkbox: true
extra_css:
  - css/mkdocstrings.css