以编程方式使用文档

让您的集成对社区可用。

现在您的包已实现并通过测试,您可以发布它并添加文档以使其能被社区发现。

发布您的包

出于本指南的目的,我们将使用 PyPI 作为包注册表。如果您选择发布到其他注册表,说明可能会有所不同。

设置凭据

首先,确保您拥有 PyPI 账户:

How to create a PyPI Token

Create account

前往 PyPI 网站 并创建一个账户

Verify email

通过点击 PyPI 发送给您邮件中的链接来验证您的电子邮件地址

Enable 2FA

前往您的账户设置,点击"生成恢复代码"以启用双因素身份验证 (2FA)。要生成 API 令牌,您 **必须** 启用双因素认证 (2FA)

Generate token

前往您的账户设置并 生成一个新的 API 令牌

构建并发布

如何发布包

来自的有用指南 uv 关于如何构建和发布包到 PyPI。

添加文档

要在此站点的 集成标签页下为您的包添加文档,您需要创建相关的文档页面,并在 LangChain 文档仓库.

编写文档

根据您构建的集成类型,您需要创建不同类型的文档页面。LangChain 为不同类型的集成提供了模板,帮助您快速上手。

Chat models

Tools/toolkits

Middleware

Vector stores

向文档仓库提交 PR

创建 LangChain 文档仓库 (不是主 langchain 仓库),在个人 GitHub 账户下创建,并克隆到本地。为您的集成创建一个新分支。复制模板并使用您喜欢的 Markdown 文本编辑器进行修改。务必参考并遵循 文档指南 编写文档。

请耐心等待,我们处理大量 PR 会需要一些时间。我们会尽快审核您的 PR 并提供反馈或进行合并。 **请勿反复提及维护者关于您的 PR。**

## 后续步骤 **恭喜!** 您的集成现已发布并记录在案,可供整个 LangChain 社区使用。

Co-marketing

与 LangChain 营销团队联系,探索联合营销机会。