如何为 LangChain 贡献文档：从本地构建到 API 参考

技术背景介绍

在软件开发中，文档是开发者与用户沟通的桥梁。LangChain 的文档由两部分组成：主文档和代码内文档。主文档位于 python.langchain.com，涵盖从教程到集成的广泛主题。而代码内文档则用于生成对外的 API 参考，由代码中的 docstring 自动生成。这两部分文档都是开发者与用户之间的重要信息来源。

核心原理解析

主文档

• 存储位置：位于 monorepo 的 /docs 目录。
• 格式：使用 ipython 笔记本（.ipynb）和 markdown（.mdx）编写。
• 构建工具：使用 Docusaurus 2 构建。

代码内文档

• 生成工具：使用 Sphinx 自动生成，并托管在 Read the Docs 上。
• 风格指南：遵循 Google Python Style Guide，确保所有函数、类和方法都有明确的 docstring。

代码实现演示

以下是如何在本地构建和验证文档的步骤：

安装依赖

# 在 monorepo 根目录安装所有依赖
poetry