Skip to content

文档指南#

文档贡献者指南#

docs 目录包含 LlamaIndex 文档的 Sphinx 源文本，访问 https://docs.llamaindex.ai/en/stable/ 查看完整文档。

本指南适用于任何对在本地运行 LlamaIndex 文档、对其进行更改和贡献感兴趣的人。LlamaIndex 是由其背后蓬勃发展的社区制作的，欢迎您为该项目和文档做出贡献。

构建文档#

如果尚未完成，将 LlamaIndex Github 仓库克隆到本地目录：

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

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

  • 安装 poetry - 这将帮助您管理包依赖关系
  • poetry shell - 此命令将创建一个虚拟环境，将安装的包限制在此项目中
  • poetry install --with docs - 这将安装构建文档所需的所有依赖项

使用 mkdocs 进行构建：

cd docs
mkdocs serve

然后在浏览器中打开 http://localhost:8000/ 查看生成的文档。

此托管版本将随着对文档的更改而重新构建和更新。

配置#

所有关于 mkdocs 的配置都在 mkdocs.yml 文件中。

从 llama-index 仓库的根目录运行命令 python docs/prepare_for_build.py 将更新 mkdocs.yml 中的 API 参考和示例导航以反映最新更改，并编写新的 API 参考文件。