从命令行构建#

当你编写完书籍内容后,现在是为书籍构建输出以便与他人分享的时候了。例如,你可能希望构建HTML文件来托管为静态网站,或构建PDF文件与同事分享。

通过命令行构建#

构建书籍的基本命令如下:

jupyter-book build <路径到书籍>

此外,你可以控制生成的输出类型,以及书籍构建的方式。本页其余部分将介绍其中一些选项。

构建输出类型#

你可以使用Jupyter Book构建多种输出。要选择不同的构建器,请在命令行运行jupyter-book build时使用--builder <构建器名称>配置。

以下是你可用的构建器列表:

  • html: HTML输出(默认)

  • singlehtml: 你的书籍的单一HTML页面

  • dirhtml: 具有<文件名>/index.html结构的HTML输出。

  • pdfhtml: 通过HTML输出构建PDF(参见 从书籍HTML构建PDF)

  • linkcheck: 运行Sphinx链接检查器(参见 检查书籍中的外部链接)

  • latex: 为你的书籍构建Latex文件

  • pdflatex: 通过Latex构建PDF(参见 使用LaTeX构建PDF)

清理书籍生成的文件#

你可以“清理”构建书籍时生成的文件。如果你最近更改了很多内容,这通常很有用,以确保你从干净的起点构建书籍。

你可以通过运行以下命令来清理书籍生成的内容:

jupyter-book clean mybookname/

默认情况下,这将删除mybookname/_build内的所有文件夹,但名为.jupyter_cache的文件夹除外。这确保了书籍内容的内容将被重新生成,而由运行你的书籍代码生成的缓存不会被删除(因为重新生成它可能需要一些时间)。

要同时删除.jupyter_cache文件夹,请添加--all标志,如下所示:

jupyter-book clean mybookname/ --all

这将完全移除_build/目录中的文件夹。

调试书籍构建过程#

在调试书籍构建时,以下选项可能会有帮助:

jupyter-book build -W -n --keep-going mybookname/

这将检查缺失的引用(-n),并将它们转换为错误(-W),但仍会尝试运行完整构建(--keep-going),以便你可以一次性看到所有错误。

你还可以使用-v-vvv来增加详细程度。