windows - 如何在 Windows 中使用 Sphinx 创建 PDF 文档

Question

我正在使用 Sphinx 在 Windows 中为我的 Python 项目创建文档。我需要生成 PDF 文档。我找到了很多解释如何在 Linux 中执行此操作，但没有很好的解释如何在 Windows 中执行此操作。据我了解，我需要使用 Sphinx 创建 Latex 格式，然后使用 Texworks 将 Latex 转换为 PDF。假设我创建了 Latex 格式的文档并安装了 Texworks，有人可以提供分步说明我该怎么做吗？

Answer 1

安装 MiKTeX (< 200mb)

wget -nv -N http://mirrors.ctan.org/systems/win32/miktex/setup/miktex-portable-2.9.4757.exe
7z.exe x -y miktex-portable-2.9.4757.exe -o"miktex"

将 bin 目录添加到您的路径

SET Path=%Path%;%CD%\miktex\miktex\bin

运行 Sphinx 的“make.bat”来生成 .tex 文件。

SET SPHINXOPTS=-W -E
make.bat latex

调用 MiKTeX 的 pdflatex：

cd build/latex
pdflatex.exe YOUR_PROJECT_NAME.tex

生成的 PDF 将在您的 build/latex 目录中

Answer 2

安装完整的 tex live发行版，它将安装 Latex、PDF 后端和 texworks。是的，它很多，是的，它会根据您的管道安装并安装一个胖小时。但这将是次演出，现在硬盘很大。

据我所知，Texworks只是一个简单的 LaTeX 编辑器，具有一些构建功能和乳胶语法突出显示。仅编译并不需要它（您可以使用记事本）

然后只需将 tex live 二进制目录放在路径中并执行

    pdflatex <yourlatexdocument.tex>

在 cmdline 上，至少这是我对我们自己的文档生成工具的乳胶输出所做的

Answer 3

如您所见：使用 Sphinx 生成 LaTeX 源代码，然后通过 LaTex 编译器运行它以生成 PDF。

我建议您使用其中一种在线 LaTeX 服务，而不是为安装 LaTeX（这可能令人生畏）和设置编辑器而烦恼。然后，您只需在 ShareLaTeX 或 Overleaf 中创建一个项目，例如（正在合并中），上传 Sphinx build\latex 目录的内容，在线编译，并下载完成的 PDF。

这工作得相当好，但由于输出目标非常不同（HTML 与正式文档），您可能必须摆弄 reST 才能以您喜欢的方式获得东西。