Ragas Ragas
stable · 中文译文
中文译文 · 原文:https://docs.ragas.io/en/stable/community/pdf_export/ · 许可证 Apache-2.0

PDF 导出

目的

PDF 导出功能使用 MkDocs 与 mkdocs-to-pdf 插件,把完整的 Ragas 文档构建成单个 PDF 文件。

用法

实现使用两套 MkDocs 配置: - mkdocs.yml 用于标准 HTML 构建(不需要 PDF 依赖) - mkdocs-pdf.yml 继承主配置并加入 PDF 插件

构建 PDF 文档:

make build-docs-pdf

生成的 PDF 位于 site/pdf/document.pdf。

只构建 HTML 文档:

make build-docs

make build-docs-pdf 命令会在构建前自动检查系统依赖。

PDF 中的 Mermaid 图(离线)

在 PDF 构建期间,Mermaid 图是离线渲染的(在 WeasyPrint 运行前转换成 SVG)。除 WeasyPrint 外,还需要一些额外依赖。

所需工具

  • Node.js(运行 Mermaid 工具链)。
  • Mermaid CLI(mmdc),通过 @mermaid-js/mermaid-cli 安装。
  • 供 Puppeteer 使用的无头浏览器(推荐:chrome-headless-shell)。

当前限制

系统依赖:WeasyPrint 需要特定操作系统的系统库(Pango、Cairo),必须单独安装。如果遇到问题,请参阅 WeasyPrint 安装说明 和 故障排除指南。

ReadTheDocs:当前 ReadTheDocs 构建配置尚未启用 PDF 生成。