Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

代码 API(rustdoc / Sphinx)

各 Rust crate 与 Python 包的逐项 API 文档,分别由 rustdoc(Rust)和 Sphinx(Python)从源码注释生成。

Rust crates

Crate角色文档
robonix-atlas能力目录 / 注册中心API
robonix-executor方案编排与能力分发API
robonix-pilot规划 / 决策 / 记忆API
robonix-liaison人机交互入口API
robonix-codegen能力约定 / IDL 代码生成API
rbnx(robonix-cli)开发 / 部署 CLIAPI

本地预览:cargo doc --no-deps --workspace(产物在 target/doc/,对应到 api/rust/)。

Python 包

由 Sphinx(autodoc + napoleon + furo 主题)生成。

角色文档
robonix-apiPython SDK(primitive / service / skill、atlas、lifecycle、Channel)API
scene(scene_service)场景 / 语义地图服务的 Python 实现API

scene 是服务,它的对外 API 是能力约定(见 能力约定参考robonix/system/scene/*);这里收录的是它的 Python 实现文档。

本地预览:pip install sphinx furo && sphinx-build -b html apidoc/python src/api/python(在 docs/ 下运行)。

若本地没有 api/ 目录,上面的链接会 404——按各自的命令在本地生成,或直接看 Pages 部署版。