Docs Draft (#286)

2026-09-13 13:17:52 +02:00 · 2024-04-15 22:44:12 -07:00
parent eb10fe599b
commit 85f48da84e
22 changed files with 544 additions and 527 deletions
@@ -4,8 +4,8 @@ site_url: https://langchain-ai.github.io/langgraph/
 theme:
  name: material
  custom_dir: overrides
-  logo: static/img/brand/wordmark.png
-  favicon: static/img/brand/favicon.png
+  logo: static/wordmark.png
+  favicon: static/favicon.png
  features:
    - announce.dismiss
    - content.action.edit
@@ -54,10 +54,25 @@ plugins:
  - 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
@@ -69,83 +84,82 @@ plugins:
 nav:
  - Home: 
      - 'index.md'
-      - Quick Start: quick_start.ipynb
-  - Concepts:
-      - 'concepts.md'
-  - "How-to Guides":
-      - Basics:
-          - State Management: how-tos/state-model.ipynb
-          - Tool Integration: how-tos/sql_example.ipynb
-          - Human-in-the-Loop: how-tos/human-in-the-loop.ipynb
-      - Performance:  
-          - Async Execution: how-tos/async.ipynb
-          - Streaming Responses: how-tos/streaming-tokens.ipynb
-      - Graph Structure:
-          - Subgraphs: how-tos/subgraph.ipynb 
-          - Branching: how-tos/branching.ipynb
-      - Development:
-          - Persistence: how-tos/persistence.ipynb
-          - Visualization: how-tos/visualization.ipynb 
-          - Time Travel: how-tos/time-travel.ipynb
-          - Benchmarking: how-tos/swe-bench.ipynb
+      - Quick Start: how-tos/docs/quickstart.ipynb
  - Tutorials:
-      - Agent Executors:
-          - Chat Agent (Function Calling):
-              - Base: tutorials/chat_agent_executor_with_function_calling/base.ipynb
-              - High-Level: tutorials/chat_agent_executor_with_function_calling/high-level.ipynb
-              - High-Level Tools: tutorials/chat_agent_executor_with_function_calling/high-level-tools.ipynb
-              - Modifications:
-                  - Human-in-the-Loop: tutorials/chat_agent_executor_with_function_calling/human-in-the-loop.ipynb
-                  - Force Tool First: tutorials/chat_agent_executor_with_function_calling/force-calling-a-tool-first.ipynb
-                  - Respond in Format: tutorials/chat_agent_executor_with_function_calling/respond-in-format.ipynb 
-                  - Dynamic Direct Return: tutorials/chat_agent_executor_with_function_calling/dynamically-returning-directly.ipynb
-                  - Manage Agent Steps: tutorials/chat_agent_executor_with_function_calling/managing-agent-steps.ipynb
-          - Langchain Agent:
-              - Base: tutorials/agent_executor/base.ipynb
-              - High-Level: tutorials/agent_executor/high-level.ipynb  
-              - Modifications:
-                  - Human-in-the-Loop: tutorials/agent_executor/human-in-the-loop.ipynb
-                  - Force Tool First: tutorials/agent_executor/force-calling-a-tool-first.ipynb
-                  - Manage Agent Steps: tutorials/agent_executor/managing-agent-steps.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
-      - 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
-      - Research & QA:   
-          - Web Research (STORM): tutorials/storm/storm.ipynb
-          - Retrieval-Augmented Generation:
+      - 'tutorials/index.md'
+      - Agent Executor:
+            - "Base": tutorials/agent_executor/base.ipynb
+            - "High-Level": tutorials/agent_executor/high-level.ipynb
+      - Chat Agent Executor:
+            - "Base": tutorials/chat_agent_executor_with_function_calling/base.ipynb
+            - "High-Level": tutorials/chat_agent_executor_with_function_calling/high-level.ipynb
+            - "Tool Node": tutorials/chat_agent_executor_with_function_calling/prebuilt-tool-node.ipynb
+            - "High-Level Tools": tutorials/chat_agent_executor_with_function_calling/high-level-tools.ipynb
+      - Use cases:
+          - Chatbots:
+              - Customer Support: tutorials/chatbots/customer-support.ipynb
+              - Info Gathering: tutorials/chatbots/information-gather-prompting.ipynb
+          - Code Assistant: tutorials/code_assistant/langgraph_code_assistant.ipynb
+          - Web Navigation: tutorials/web-navigation/web_voyager.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_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.ipynb
              - tutorials/rag/langgraph_self_rag_local.ipynb
-      - Applications:
-          - Chatbots: 
-              - Customer Support: tutorials/chatbots/customer-support.ipynb
-              - Info Gathering: tutorials/chatbots/information-gather-prompting.ipynb
-          - Code Assistant: tutorials/code_assistant/langgraph_code_assistant.ipynb  
-          - Web Navigation: tutorials/web-navigation/web_voyager.ipynb
-      - Evaluation & Analysis:  
-          - Chatbot Eval via Sim:
-              - Agent-based: tutorials/chatbot-simulation-evaluation/agent-simulation-evaluation.ipynb
-              - Dataset-based: tutorials/chatbot-simulation-evaluation/langsmith-agent-simulation-evaluation.ipynb  
-          - Self-Discovering Agent: tutorials/self-discover/self-discover.ipynb
-          - Swarm: tutorials/gptswarm/swarm.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
+                  - Dataset-based: tutorials/chatbot-simulation-evaluation/langsmith-agent-simulation-evaluation.ipynb
+
+  - "How-to Guides":
+      - 'how-tos/index.md'
+      - Core:
+          - "Quick Start": how-tos/docs/quickstart.ipynb
+          - "State Management": how-tos/state-model.ipynb
+          - "Async Execution": how-tos/async.ipynb
+          - "Streaming Responses": how-tos/streaming-tokens.ipynb
+          - "Human-in-the-Loop": how-tos/human-in-the-loop.ipynb
+          - "Persistence": how-tos/persistence.ipynb
+          - "Time Travel": how-tos/time-travel.ipynb
+          - "Visualization": how-tos/visualization.ipynb
+          - "Pydantic State": how-tos/state-model.ipynb
+          - "Subgraphs": how-tos/subgraph.ipynb
+          - "Branching": how-tos/branching.ipynb
+      - Chat Agent (Function Calling):
+          - Human-in-the-Loop: how-tos/chat_agent_executor_with_function_calling/human-in-the-loop.ipynb
+          - Force Tool First: how-tos/chat_agent_executor_with_function_calling/force-calling-a-tool-first.ipynb
+          - Respond in Format: how-tos/chat_agent_executor_with_function_calling/respond-in-format.ipynb
+          - Dynamic Direct Return: how-tos/chat_agent_executor_with_function_calling/dynamically-returning-directly.ipynb
+          - Manage Agent Steps: how-tos/chat_agent_executor_with_function_calling/managing-agent-steps.ipynb
+      - AgentExecutor:
+          - Human-in-the-Loop: how-tos/agent_executor/human-in-the-loop.ipynb
+          - Force Tool First: how-tos/agent_executor/force-calling-a-tool-first.ipynb
+          - Manage Agent Steps: how-tos/agent_executor/managing-agent-steps.ipynb
+      - Persistance:
+          - "Persistance in Postgres": how-tos/persistence_postgres.ipynb
+
  - Reference:
      - Graphs: reference/graphs.md
      - Checkpointing: reference/checkpoints.md
-      - Prebuilt Components: reference/prebuilt_components.md
+      - Prebuilt Components: reference/prebuilt.md
  

 markdown_extensions: