跳到内容

文档#

此目录包含 LlamaIndex 的文档源代码，可访问 https://docs.llamaindex.org.cn。

本指南适用于任何有兴趣在本地运行 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

构建过程中，notebooks 会被转换为文档页面，这需要几分钟时间。如果您不在文档的“示例”部分工作，可以运行相同的命令并加上 --skip-notebooks 参数

poetry run serve --skip-notebooks

重要

构建文档需要一些时间，因此在打开浏览器之前请确保看到以下输出

...
INFO    -  Documentation built in 53.32 seconds
INFO    -  [16:18:17] Watching paths for changes: 'docs'
INFO    -  [16:18:17] Serving on http://127.0.0.1:8000/en/stable/

您现在可以在浏览器中打开 http://localhost:8000/ 来查看生成的文档。本地服务器会在您每次更改文档时重新构建文档并刷新您的浏览器。

配置#

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

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

提示

作为贡献者，您通常不需要运行此脚本，如果在 PR 中遇到问题，请随时寻求帮助。