From 41a4f993b195503765fd7991df679f979733eed1 Mon Sep 17 00:00:00 2001 From: Lauren Hirata Singh Date: Thu, 31 Jul 2025 18:06:35 -0400 Subject: [PATCH] docs: Update link maps for reference docs (#5745) Update link maps --------- Co-authored-by: Hunter Lovell --- docs/_scripts/link_map.py | 116 ++++++++++++++++---------------------- 1 file changed, 50 insertions(+), 66 deletions(-) diff --git a/docs/_scripts/link_map.py b/docs/_scripts/link_map.py index 9c662349d..4b59836ec 100644 --- a/docs/_scripts/link_map.py +++ b/docs/_scripts/link_map.py @@ -4,52 +4,48 @@ This module provides link mappings for different language/framework scopes to resolve @[link_name] references to actual URLs. """ -# Python-specific link mappings # Python-specific link mappings PYTHON_LINK_MAP = { "StateGraph": "reference/graphs/#langgraph.graph.StateGraph", - "add_conditional_edges": "reference/graphs/#langgraph.graph.StateGraph.add_conditional_edges", - "add_edge": "reference/graphs/#langgraph.graph.StateGraph.add_edge", - "add_node": "reference/graphs/#langgraph.graph.StateGraph.add_node", - "add_messages": "reference/messages/#langgraph.graph.message.add_messages", - "ToolNode": "reference/prebuilt/#langgraph.prebuilt.tool_node.ToolNode", + "add_conditional_edges": "reference/graphs/#langgraph.graph.state.StateGraph.add_conditional_edges", + "add_edge": "reference/graphs/#langgraph.graph.state.StateGraph.add_edge", + "add_node": "reference/graphs/#langgraph.graph.state.StateGraph.add_node", + "add_messages": "reference/graphs/#langgraph.graph.message.add_messages", + "ToolNode": "reference/agents/#langgraph.prebuilt.tool_node.ToolNode", "CompiledStateGraph.astream": "reference/graphs/#langgraph.graph.state.CompiledStateGraph.astream", - "Pregel.astream": "reference/graphs/#langgraph.pregel.Pregel.astream", + "Pregel.astream": "reference/pregel/#langgraph.pregel.Pregel.astream", "AsyncPostgresSaver": "reference/checkpoints/#langgraph.checkpoint.postgres.aio.AsyncPostgresSaver", "AsyncSqliteSaver": "reference/checkpoints/#langgraph.checkpoint.sqlite.aio.AsyncSqliteSaver", "BaseCheckpointSaver": "reference/checkpoints/#langgraph.checkpoint.base.BaseCheckpointSaver", - "BaseStore": "reference/stores/#langgraph.store.base.BaseStore", - "BaseStore.put": "reference/stores/#langgraph.store.base.BaseStore.put", - "BinaryOperatorAggregate": "reference/channels/#langgraph.channels.BinaryOperatorAggregate", + "BaseStore": "reference/store/#langgraph.store.base.BaseStore", + "BaseStore.put": "reference/store/#langgraph.store.base.BaseStore.put", + "BinaryOperatorAggregate": "reference/pregel/#langgraph.pregel.Pregel--advanced-channels-context-and-binaryoperatoraggregate", "CipherProtocol": "reference/checkpoints/#langgraph.checkpoint.serde.base.CipherProtocol", - "client.runs.stream": "reference/client/#langgraph_sdk.client.RunsClient.stream", - "client.runs.wait": "reference/client/#langgraph_sdk.client.RunsClient.wait", - "client.threads.get_history": "reference/client/#langgraph_sdk.client.ThreadsClient.get_history", - "client.threads.update_state": "reference/client/#langgraph_sdk.client.ThreadsClient.update_state", + "client.runs.stream": "cloud/reference/sdk/python_sdk_ref/#langgraph_sdk.client.RunsClient.stream", + "client.runs.wait": "cloud/reference/sdk/python_sdk_ref/#langgraph_sdk.client.RunsClient.wait", + "client.threads.get_history": "cloud/reference/sdk/python_sdk_ref/#langgraph_sdk.client.ThreadsClient.get_history", + "client.threads.update_state": "cloud/reference/sdk/python_sdk_ref/#langgraph_sdk.client.ThreadsClient.update_state", "Command": "reference/types/#langgraph.types.Command", "CompiledStateGraph": "reference/graphs/#langgraph.graph.state.CompiledStateGraph", "create_react_agent": "reference/prebuilt/#langgraph.prebuilt.chat_agent_executor.create_react_agent", "create_supervisor": "reference/supervisor/#langgraph_supervisor.supervisor.create_supervisor", "EncryptedSerializer": "reference/checkpoints/#langgraph.checkpoint.serde.encrypted.EncryptedSerializer", - "entrypoint.final": "reference/functions/#langgraph.func.entrypoint.final", - "entrypoint": "reference/functions/#langgraph.func.entrypoint", + "entrypoint.final": "reference/func/#langgraph.func.entrypoint.final", + "entrypoint": "reference/func/#langgraph.func.entrypoint", "from_pycryptodome_aes": "reference/checkpoints/#langgraph.checkpoint.serde.encrypted.EncryptedSerializer.from_pycryptodome_aes", - # "getContextVariable": "", "get_state_history": "reference/graphs/#langgraph.graph.state.CompiledStateGraph.get_state_history", "get_stream_writer": "reference/config/#langgraph.config.get_stream_writer", "HumanInterrupt": "reference/prebuilt/#langgraph.prebuilt.interrupt.HumanInterrupt", - "InjectedState": "reference/prebuilt/#langgraph.prebuilt.InjectedState", + "InjectedState": "reference/agents/#langgraph.prebuilt.tool_node.InjectedState", "InMemorySaver": "reference/checkpoints/#langgraph.checkpoint.memory.InMemorySaver", - "interrupt": "reference/graphs/#langgraph.graph.interrupt", + "interrupt": "reference/types/#langgraph.types.Interrupt", "CompiledStateGraph.invoke": "reference/graphs/#langgraph.graph.state.CompiledStateGraph.invoke", "JsonPlusSerializer": "reference/checkpoints/#langgraph.checkpoint.serde.jsonplus.JsonPlusSerializer", - "langgraph.json": "reference/configuration/#configuration-file", + "langgraph.json": "cloud/reference/cli/#configuration-file", "LastValue": "reference/channels/#langgraph.channels.LastValue", - # "MemorySaver": "", - # "messagesStateReducer": "", "PostgresSaver": "reference/checkpoints/#langgraph.checkpoint.postgres.PostgresSaver", - "Pregel": "reference/graphs/#langgraph.pregel.Pregel", - "Pregel.stream": "reference/graphs/#langgraph.pregel.Pregel.stream", + "Pregel": "reference/pregel/", + "Pregel.stream": "reference/pregel/#langgraph.pregel.Pregel.stream", "pre_model_hook": "reference/prebuilt/#langgraph.prebuilt.chat_agent_executor.create_react_agent", "protocol": "reference/checkpoints/#langgraph.checkpoint.serde.base.SerializerProtocol", "Send": "reference/types/#langgraph.types.Send", @@ -57,68 +53,56 @@ PYTHON_LINK_MAP = { "SqliteSaver": "reference/checkpoints/#langgraph.checkpoint.sqlite.SqliteSaver", "START": "reference/constants/#langgraph.constants.START", "CompiledStateGraph.stream": "reference/graphs/#langgraph.graph.state.CompiledStateGraph.stream", - "task": "reference/functions/#langgraph.func.task", + "task": "reference/func/#langgraph.func.task", "Topic": "reference/channels/#langgraph.channels.Topic", "update_state": "reference/graphs/#langgraph.graph.state.CompiledStateGraph.update_state", } - # JavaScript-specific link mappings JS_LINK_MAP = { "Auth": "reference/classes/sdk_auth.Auth.html", "StateGraph": "reference/classes/langgraph.StateGraph.html", - "add_conditional_edges": "reference/functions/langgraph_StateGraph.addConditionalEdges.html", - "add_edge": "reference/functions/langgraph_StateGraph.addEdge.html", - "add_node": "reference/functions/langgraph_StateGraph.addNode.html", - "add_messages": "reference/functions/langgraph_message.addMessages.html", + "add_conditional_edges": "/reference/classes/langgraph.StateGraph.html#addConditionalEdges", + "add_edge": "reference/classes/langgraph.StateGraph.html#addEdge", + "add_node": "reference/classes/langgraph.StateGraph.html#addNode", + "add_messages": "reference/modules/langgraph.html#addMessages", "ToolNode": "reference/classes/langgraph_prebuilt.ToolNode.html", - "CompiledStateGraph.astream()": "reference/functions/langgraph_CompiledStateGraph.astream.html", - "Pregel.astream": "reference/functions/langgraph_Pregel.astream.html", - "AsyncPostgresSaver": "reference/classes/langgraph_checkpoint_postgres_aio.AsyncPostgresSaver.html", - "AsyncSqliteSaver": "reference/classes/langgraph_checkpoint_sqlite_aio.AsyncSqliteSaver.html", - "BaseCheckpointSaver": "reference/classes/langgraph_checkpoint_base.BaseCheckpointSaver.html", - "BaseStore": "reference/classes/langgraph_store_base.BaseStore.html", - "BaseStore.put": "reference/functions/langgraph_store_base.BaseStore.put.html", - "BinaryOperatorAggregate": "reference/classes/langgraph_channels.BinaryOperatorAggregate.html", - "CipherProtocol": "reference/classes/langgraph_checkpoint_serde_base.CipherProtocol.html", - "client.runs.stream": "reference/functions/langgraph_sdk_client.RunsClient.stream.html", - "client.runs.wait": "reference/functions/langgraph_sdk_client.RunsClient.wait.html", - "client.threads.get_history": "reference/functions/langgraph_sdk_client.ThreadsClient.getHistory.html", - "client.threads.update_state": "reference/functions/langgraph_sdk_client.ThreadsClient.updateState.html", + "BaseCheckpointSaver": "reference/classes/checkpoint.BaseCheckpointSaver.html", + "BaseStore": "reference/classes/checkpoint.BaseStore.html", + "BaseStore.put": "reference/classes/checkpoint.BaseStore.html#put", + "BinaryOperatorAggregate": "reference/classes/langgraph.BinaryOperatorAggregate.html", + "client.runs.stream": "reference/classes/sdk_client.RunsClient.html#stream", + "client.runs.wait": "reference/classes/sdk_client.RunsClient.html#wait", + "client.threads.get_history": "reference/classes/sdk_client.ThreadsClient.html#getHistory", + "client.threads.update_state": "reference/classes/sdk_client.ThreadsClient.html#updateState", "Command": "reference/classes/langgraph.Command.html", "CompiledStateGraph": "reference/classes/langgraph.CompiledStateGraph.html", "create_react_agent": "reference/functions/langgraph_prebuilt.createReactAgent.html", "create_supervisor": "reference/functions/langgraph_supervisor.createSupervisor.html", - "EncryptedSerializer": "reference/classes/langgraph_checkpoint_serde_encrypted.EncryptedSerializer.html", - "entrypoint.final": "reference/functions/langgraph_func.entrypoint.final.html", - "entrypoint": "reference/functions/langgraph_func.entrypoint.html", - "from_pycryptodome_aes": "reference/functions/langgraph_checkpoint_serde_encrypted.EncryptedSerializer.fromPycryptodomeAes.html", + "entrypoint.final": "reference/functions/langgraph.entrypoint.html#final", + "entrypoint": "reference/functions/langgraph.entrypoint.html", "getContextVariable": "https://v03.api.js.langchain.com/functions/_langchain_core.context.getContextVariable.html", - "get_state_history": "reference/functions/langgraph_CompiledStateGraph.getStateHistory.html", - "get_stream_writer": "reference/functions/langgraph_config.getStreamWriter.html", - "HumanInterrupt": "reference/classes/langgraph_prebuilt.HumanInterrupt.html", - "InjectedState": "reference/classes/langgraph_prebuilt.InjectedState.html", - "InMemorySaver": "reference/classes/langgraph_checkpoint_memory.InMemorySaver.html", + "get_state_history": "reference/classes/langgraph.CompiledStateGraph.html#getStateHistory", + "HumanInterrupt": "reference/interfaces/langgraph_prebuilt.HumanInterrupt.html", "interrupt": "reference/functions/langgraph.interrupt-2.html", - "CompiledStateGraph.invoke": "reference/functions/langgraph_CompiledStateGraph.invoke.html", - "JsonPlusSerializer": "reference/classes/langgraph_checkpoint_serde_jsonplus.JsonPlusSerializer.html", - "langgraph.json": "reference/configuration.html", - "LastValue": "reference/classes/langgraph_channels.LastValue.html", + "CompiledStateGraph.invoke": "reference/classes/langgraph.CompiledStateGraph.html#invoke", + "langgraph.json": "cloud/reference/cli/#configuration-file", "MemorySaver": "reference/classes/checkpoint.MemorySaver.html", "messagesStateReducer": "reference/functions/langgraph.messagesStateReducer.html", - "PostgresSaver": "reference/classes/langgraph_checkpoint_postgres.PostgresSaver.html", + "PostgresSaver": "reference/classes/checkpoint_postgres.PostgresSaver.html", "Pregel": "reference/classes/langgraph.Pregel.html", - "Pregel.stream": "reference/functions/langgraph_Pregel.stream.html", + "Pregel.stream": "reference/classes/langgraph.Pregel.html#stream", "pre_model_hook": "reference/functions/langgraph_prebuilt.createReactAgent.html", - "protocol": "reference/classes/langgraph_checkpoint_serde_base.SerializerProtocol.html", + "protocol": "reference/interfaces/checkpoint.SerializerProtocol.html", "Send": "reference/classes/langgraph.Send.html", - "SerializerProtocol": "reference/classes/langgraph_checkpoint_serde_base.SerializerProtocol.html", - "SqliteSaver": "reference/classes/langgraph_checkpoint_sqlite.SqliteSaver.html", - "START": "reference/constants.html#START", - "CompiledStateGraph.stream": "reference/functions/langgraph_CompiledStateGraph.stream.html", - "task": "reference/functions/langgraph_func.task.html", - "Topic": "reference/classes/langgraph_channels.Topic.html", - "update_state": "reference/functions/langgraph_CompiledStateGraph.updateState.html", + "SerializerProtocol": "reference/interfaces/checkpoint.SerializerProtocol.html", + "SqliteSaver": "reference/classes/checkpoint_sqlite.SqliteSaver.html", + "START": "reference/variables/langgraph.START.html", + "CompiledStateGraph.stream": "reference/classes/langgraph.CompiledStateGraph.html#stream", + "task": "reference/functions/langgraph.task.html", + ## TODO (hntrl): export Topic from langgraphjs + # "Topic": "reference/classes/langgraph_channels.Topic.html", + "update_state": "reference/classes/langgraph.CompiledStateGraph.html#updateState", } # TODO: Allow updating these to localhost for local development