使用 PyLaTeX 生成带目录的 PDF 时目录为空的解决方案

在使用 PyLaTeX 创建包含目录的 PDF 文档时，有时会遇到目录页仅显示 “Contents” 字样，而没有实际的章节和页码信息。这通常是因为 LaTeX 需要进行多次编译才能正确生成目录。第一次编译会提取文档中的章节信息并保存到中间文件中，第二次编译才会读取这些信息并生成目录。

PyLaTeX 提供了 clean_tex=True 选项，用于在编译完成后清理中间文件。如果设置了此选项，则第一次编译生成的中间文件会被删除，导致无法生成目录。

为了解决这个问题，建议安装 latexmk 工具。latexmk 是一个 perl 脚本，可以自动检测 LaTeX 文档的依赖关系，并根据需要多次运行 LaTeX 编译命令，直到文档中的所有引用和目录都正确生成。

安装 latexmk

latexmk 的安装方式取决于你的操作系统。以下是一些常见操作系统的安装方法：

• macOS (使用 Homebrew):

  brew install latexmk

• debian/ubuntu:

  sudo apt-get update sudo apt-get install latexmk

• windows (使用 Chocolatey):

  choco install latexmk

使用 latexmk

安装 latexmk 后，PyLaTeX 会自动检测并使用它。你无需修改现有的 PyLaTeX 代码。只需确保你的系统中安装了 latexmk，并且在调用 doc.generate_pdf() 方法时，可以保留 clean_tex=True 选项，PyLaTeX 会自动使用 latexmk 进行编译，从而正确生成目录。

示例代码

from pylatex import Document, Section, Subsection, Command, NewPage, NoEscape  # 创建文档 doc = Document()  # 添加章节和子章节 with doc.create(Section('Introduction')):     doc.append("This is the introduction.")     with doc.create(Subsection('Background')):         doc.append("This is the background.")  with doc.create(Section('Methods')):     doc.append("This section describes the methods.")  # 添加目录 doc.append(NewPage()) doc.append(Command('tableofcontents')) doc.append(NoEscape(r'clearpage'))  # 生成 PDF doc.generate_pdf('my_document', clean_tex=True)

注意事项

• 确保你的系统中安装了 LaTeX 发行版，例如 TeX Live 或 MiKTeX。
• 安装 latexmk 后，可能需要重启你的终端或 ide，以便系统能够找到 latexmk 命令。
• 如果在使用 latexmk 后仍然无法生成目录，请检查你的 LaTeX 代码是否存在语法错误，或者尝试手动运行 latexmk 命令来排查问题。例如，在命令行中执行 latexmk my_document.tex。
• 如果你的文档非常复杂，可能需要手动配置 latexmk 的选项，例如指定编译次数或使用的 LaTeX 引擎。

总结

通过安装 latexmk 工具，可以有效解决 PyLaTeX 生成 PDF 文档时目录为空的问题。latexmk 能够自动完成 LaTeX 的多次编译，确保目录信息正确生成。这种方法简单易用，无需修改现有的 PyLaTeX 代码，是生成包含目录的 PDF 文档的推荐方法。