Skip to content

Commit

Permalink
docs: add generated docc documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
bsorrentino committed Aug 14, 2024
1 parent 9e6ce90 commit a3d1cc5
Show file tree
Hide file tree
Showing 209 changed files with 595 additions and 1 deletion.
3 changes: 2 additions & 1 deletion Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ let package = Package(
name: "LangGraph", dependencies: [
// .product(name: "AsyncAlgorithms", package: "swift-async-algorithms"),
],
resources: [ .process("Resources")]
resources: [ .process("Resources")],
exclude: ["LangChainDemo", "Tests", "docs"]
// plugins: [
// .plugin(name: "Swift-DocC", package: "swift-docc-plugin")
// ]
Expand Down
7 changes: 7 additions & 0 deletions docs.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
swift package \
--allow-writing-to-directory ./docs \
generate-documentation --target LangGraph \
--disable-indexing \
--transform-for-static-hosting \
--hosting-base-path LangGraph \
--output-path ./docs
9 changes: 9 additions & 0 deletions docs/css/523.e9a069b0.css

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions docs/css/675.40c3bcb2.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 9 additions & 0 deletions docs/css/documentation-topic.b186e79f.css

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions docs/css/index.ff036a9e.css

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions docs/css/topic.672a9049.css

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions docs/css/tutorials-overview.6eb589ed.css

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/data/documentation/langgraph.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"variants":[{"paths":["\/documentation\/langgraph"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"modules":[{"name":"LangGraph"}],"title":"LangGraph","externalID":"LangGraph","symbolKind":"module","role":"collection","roleHeading":"Framework"},"schemaVersion":{"minor":3,"patch":0,"major":0},"topicSections":[{"identifiers":["doc:\/\/LangGraph\/documentation\/LangGraph\/AppenderChannel","doc:\/\/LangGraph\/documentation\/LangGraph\/Channel","doc:\/\/LangGraph\/documentation\/LangGraph\/StateGraph"],"title":"Classes"},{"title":"Protocols","identifiers":["doc:\/\/LangGraph\/documentation\/LangGraph\/AgentState","doc:\/\/LangGraph\/documentation\/LangGraph\/ChannelProtocol"]},{"title":"Structures","identifiers":["doc:\/\/LangGraph\/documentation\/LangGraph\/BaseAgentState","doc:\/\/LangGraph\/documentation\/LangGraph\/NodeOutput"]},{"identifiers":["doc:\/\/LangGraph\/documentation\/LangGraph\/END","doc:\/\/LangGraph\/documentation\/LangGraph\/START"],"title":"Variables"},{"identifiers":["doc:\/\/LangGraph\/documentation\/LangGraph\/Channels","doc:\/\/LangGraph\/documentation\/LangGraph\/DefaultProvider","doc:\/\/LangGraph\/documentation\/LangGraph\/EdgeCondition","doc:\/\/LangGraph\/documentation\/LangGraph\/NodeAction","doc:\/\/LangGraph\/documentation\/LangGraph\/PartialAgentState","doc:\/\/LangGraph\/documentation\/LangGraph\/Reducer","doc:\/\/LangGraph\/documentation\/LangGraph\/StateFactory"],"title":"Type Aliases"},{"title":"Enumerations","identifiers":["doc:\/\/LangGraph\/documentation\/LangGraph\/CompiledGraphError","doc:\/\/LangGraph\/documentation\/LangGraph\/StateGraphError"]}],"identifier":{"url":"doc:\/\/LangGraph\/documentation\/LangGraph","interfaceLanguage":"swift"},"sections":[],"hierarchy":{"paths":[[]]},"kind":"symbol","references":{"doc://LangGraph/documentation/LangGraph/AppenderChannel":{"type":"topic","abstract":[{"type":"text","text":"A specialized "},{"code":"Channel","type":"codeVoice"},{"text":" that appends new values to an array of existing values.","type":"text"}],"fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AppenderChannel","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"AppenderChannel"}],"kind":"symbol","role":"symbol","identifier":"doc:\/\/LangGraph\/documentation\/LangGraph\/AppenderChannel","url":"\/documentation\/langgraph\/appenderchannel","title":"AppenderChannel"},"doc://LangGraph/documentation/LangGraph/NodeAction":{"kind":"symbol","type":"topic","identifier":"doc:\/\/LangGraph\/documentation\/LangGraph\/NodeAction","role":"symbol","navigatorTitle":[{"text":"NodeAction","kind":"identifier"}],"title":"NodeAction","url":"\/documentation\/langgraph\/nodeaction","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"NodeAction"}],"abstract":[{"text":"A typealias representing an action to be performed on an agent state.","type":"text"}]},"doc://LangGraph/documentation/LangGraph/END":{"abstract":[{"text":"Identifier of the edge ending workflow ( = ","type":"text"},{"code":"\"__END__\"","type":"codeVoice"},{"text":" )","type":"text"}],"fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"END","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"identifier":"doc:\/\/LangGraph\/documentation\/LangGraph\/END","title":"END","role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/langgraph\/end"},"doc://LangGraph/documentation/LangGraph/ChannelProtocol":{"url":"\/documentation\/langgraph\/channelprotocol","identifier":"doc:\/\/LangGraph\/documentation\/LangGraph\/ChannelProtocol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ChannelProtocol"}],"type":"topic","navigatorTitle":[{"text":"ChannelProtocol","kind":"identifier"}],"title":"ChannelProtocol","abstract":[{"type":"text","text":"A protocol defining the requirements for a channel."}],"kind":"symbol","role":"symbol"},"doc://LangGraph/documentation/LangGraph/DefaultProvider":{"url":"\/documentation\/langgraph\/defaultprovider","abstract":[{"text":"A typealias representing a default value provider.","type":"text"}],"title":"DefaultProvider","navigatorTitle":[{"text":"DefaultProvider","kind":"identifier"}],"identifier":"doc:\/\/LangGraph\/documentation\/LangGraph\/DefaultProvider","kind":"symbol","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"text":"DefaultProvider","kind":"identifier"}]},"doc://LangGraph/documentation/LangGraph/BaseAgentState":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"BaseAgentState"}],"navigatorTitle":[{"text":"BaseAgentState","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/LangGraph\/documentation\/LangGraph\/BaseAgentState","abstract":[{"type":"text","text":"A structure representing the base state of an agent."}],"title":"BaseAgentState","url":"\/documentation\/langgraph\/baseagentstate"},"doc://LangGraph/documentation/LangGraph/Channels":{"navigatorTitle":[{"text":"Channels","kind":"identifier"}],"type":"topic","url":"\/documentation\/langgraph\/channels","kind":"symbol","identifier":"doc:\/\/LangGraph\/documentation\/LangGraph\/Channels","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"text":"Channels","kind":"identifier"}],"role":"symbol","title":"Channels","abstract":[{"text":"A typealias representing channels’ map in the form [","type":"text"},{"type":"text","text":":"},{"text":"].","type":"text"}]},"doc://LangGraph/documentation/LangGraph/PartialAgentState":{"url":"\/documentation\/langgraph\/partialagentstate","kind":"symbol","title":"PartialAgentState","identifier":"doc:\/\/LangGraph\/documentation\/LangGraph\/PartialAgentState","role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PartialAgentState"}],"navigatorTitle":[{"text":"PartialAgentState","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"A typealias representing a partial state of an agent."}]},"doc://LangGraph/documentation/LangGraph/START":{"type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"START","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/LangGraph\/documentation\/LangGraph\/START","title":"START","kind":"symbol","role":"symbol","abstract":[{"text":"Identifier of the edge staring workflow ( = ","type":"text"},{"code":"\"__START__\"","type":"codeVoice"},{"type":"text","text":" )"}],"url":"\/documentation\/langgraph\/start"},"doc://LangGraph/documentation/LangGraph/StateGraph":{"title":"StateGraph","identifier":"doc:\/\/LangGraph\/documentation\/LangGraph\/StateGraph","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"StateGraph"}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"StateGraph","kind":"identifier"}],"url":"\/documentation\/langgraph\/stategraph","abstract":[{"type":"text","text":"A class representing a state graph."}]},"doc://LangGraph/documentation/LangGraph/Channel":{"kind":"symbol","type":"topic","abstract":[{"type":"text","text":"A class representing a communication channel that conforms to "},{"type":"codeVoice","code":"ChannelProtocol"},{"type":"text","text":"."}],"title":"Channel","navigatorTitle":[{"text":"Channel","kind":"identifier"}],"identifier":"doc:\/\/LangGraph\/documentation\/LangGraph\/Channel","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Channel","kind":"identifier"}],"url":"\/documentation\/langgraph\/channel","role":"symbol"},"doc://LangGraph/documentation/LangGraph/EdgeCondition":{"title":"EdgeCondition","abstract":[{"type":"text","text":"A typealias representing a condition to be checked on an agent state."}],"identifier":"doc:\/\/LangGraph\/documentation\/LangGraph\/EdgeCondition","kind":"symbol","role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"EdgeCondition"}],"url":"\/documentation\/langgraph\/edgecondition","navigatorTitle":[{"kind":"identifier","text":"EdgeCondition"}],"type":"topic"},"doc://LangGraph/documentation/LangGraph/StateFactory":{"kind":"symbol","type":"topic","identifier":"doc:\/\/LangGraph\/documentation\/LangGraph\/StateFactory","role":"symbol","navigatorTitle":[{"text":"StateFactory","kind":"identifier"}],"title":"StateFactory","url":"\/documentation\/langgraph\/statefactory","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"StateFactory","kind":"identifier"}],"abstract":[{"type":"text","text":"A typealias representing a factory for creating agent states."}]},"doc://LangGraph/documentation/LangGraph/Reducer":{"title":"Reducer","type":"topic","role":"symbol","identifier":"doc:\/\/LangGraph\/documentation\/LangGraph\/Reducer","kind":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"text":"Reducer","kind":"identifier"}],"abstract":[{"type":"text","text":"A typealias representing a reducer function."}],"url":"\/documentation\/langgraph\/reducer","navigatorTitle":[{"kind":"identifier","text":"Reducer"}]},"doc://LangGraph/documentation/LangGraph":{"url":"\/documentation\/langgraph","role":"collection","identifier":"doc:\/\/LangGraph\/documentation\/LangGraph","title":"LangGraph","kind":"symbol","abstract":[],"type":"topic"},"doc://LangGraph/documentation/LangGraph/NodeOutput":{"kind":"symbol","abstract":[{"type":"text","text":"A structure representing the output of a node in a state graph."}],"type":"topic","title":"NodeOutput","navigatorTitle":[{"text":"NodeOutput","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/LangGraph\/documentation\/LangGraph\/NodeOutput","url":"\/documentation\/langgraph\/nodeoutput","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"NodeOutput","kind":"identifier"}]},"doc://LangGraph/documentation/LangGraph/StateGraphError":{"title":"StateGraphError","type":"topic","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"StateGraphError"}],"abstract":[{"text":"An enumeration representing various errors that can occur in a ","type":"text"},{"code":"StateGraph","type":"codeVoice"},{"type":"text","text":"."}],"kind":"symbol","identifier":"doc:\/\/LangGraph\/documentation\/LangGraph\/StateGraphError","url":"\/documentation\/langgraph\/stategrapherror","navigatorTitle":[{"text":"StateGraphError","kind":"identifier"}]},"doc://LangGraph/documentation/LangGraph/CompiledGraphError":{"identifier":"doc:\/\/LangGraph\/documentation\/LangGraph\/CompiledGraphError","title":"CompiledGraphError","kind":"symbol","navigatorTitle":[{"text":"CompiledGraphError","kind":"identifier"}],"url":"\/documentation\/langgraph\/compiledgrapherror","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"CompiledGraphError","kind":"identifier"}],"type":"topic","role":"symbol","abstract":[{"text":"An enumeration representing errors that can occur in a compiled graph.","type":"text"}]},"doc://LangGraph/documentation/LangGraph/AgentState":{"role":"symbol","identifier":"doc:\/\/LangGraph\/documentation\/LangGraph\/AgentState","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AgentState","kind":"identifier"}],"kind":"symbol","type":"topic","title":"AgentState","url":"\/documentation\/langgraph\/agentstate","abstract":[{"type":"text","text":"A protocol representing the state of an agent."}],"navigatorTitle":[{"kind":"identifier","text":"AgentState"}]}}}
Loading

0 comments on commit a3d1cc5

Please sign in to comment.