Skip to content

文档#

本目录包含 LlamaIndex 的文档源代码，访问地址为 https://docs.llamaindex.ai。

本指南适用于所有希望本地运行 LlamaIndex 文档、进行修改并参与贡献的用户。LlamaIndex 由活跃的社区共同构建，我们始终欢迎您为项目和文档做出贡献。

构建文档#

如果尚未操作，请先将 LlamaIndex 的 Github 仓库克隆到本地目录：

git clone https://github.com/run-llama/llama_index.git && cd llama_index

文档有专属的 Python 虚拟环境，所有工具和脚本都位于 docs 目录下：

cd llama_index/docs

从现在起，我们假定所有命令都将在 docs 目录下执行。

安装构建文档所需的所有依赖（主要是 mkdocs 及其扩展）：

  • 安装 poetry - 用于管理包依赖
  • poetry install - 安装构建文档所需的所有依赖

要构建文档并在本地浏览，请运行：

poetry run serve

构建过程中会将笔记本转换为文档页面，这需要几分钟时间。如果您不涉及文档的"示例"部分，可以添加 --skip-notebooks 参数运行相同命令：

poetry run serve --skip-notebooks

Important

文档构建耗时较长，请确保看到以下输出后再打开浏览器：

...
INFO    -  文档构建耗时 53.32 秒
INFO    -  [16:18:17] 正在监视路径变更: 'docs'
INFO    -  [16:18:17] 服务运行于 http://127.0.0.1:8000/en/stable/

现在您可以在浏览器中访问 http://localhost:8000/ 查看生成的文档。本地服务器会在您修改文档后自动重建并刷新浏览器。

配置#

mkdocs.yml 中的部分配置由脚本生成，该脚本负责保持示例与本仓库中所有包的 API 参考同步。

在 docs 文件夹下运行 poetry run prepare-for-build 命令将使用最新更改更新 mkdocs.yml，并写入新的 API 参考文件。

[!TIP] 作为贡献者，通常不需要运行此脚本，如有需要可在 PR 中寻求帮助。