SphinxからTeX経由でPDF出力する環境を整える

OpenIconsによるPixabayからの画像

こんにちは。阿形です。

弊社社内では、各種ドキュメントをSphinxで書いてGitLab経由でNetlifyでビルドしWebブラウザで見られるようにしています。通常はこれで十分なんですが、諸般の事情でメール等で添付したり、紙に出力しなければならない場合、少々不便なこともあります。

SphinxでHTML出力したものをPDF化してもいいと思うのですが、せっかくなのでTeXを経由してPDF化してみます。

作業環境

いつもどおり私の環境を前提に話を進めます。私のドキュメント作成環境は以下のとおりです。

• MacBook
• macOS High Sierra (10.13.6)
• Homebrew 2.0.4
  • Homebrew/homebrew-core (git revision a290; last commit 2019-03-16)
  • Homebrew/homebrew-cask (git revision 3db818; last commit 2019-03-17)
• Sphinx 1.8.0

TeXのインストール

SphinxからPDFを生成するには、TeXを経由する必要があります。このため、TeXの処理環境が必要となります。macOSの場合、Homebrewで簡単にインストールできますので、今回はHomebrewを使用した方法でインストールします。

$ brew cask install mactex

環境にもよりますが、TeXのパッケージの容量が大きいのでかなり時間がかかります。のんびり待ちましょう。

==> Satisfying dependencies
 ==> Installing Formula dependencies: ghostscript
 ==> Installing dependencies for ghostscript: libtiff
 ==> Installing ghostscript dependency: libtiff
 ==> Downloading https://homebrew.bintray.com/bottles/libtiff-4.0.10_1.high_sierra.bottle.tar.gz
 ################################################################## 100.0%
 ==> Pouring libtiff-4.0.10_1.high_sierra.bottle.tar.gz
 ?  /usr/local/Cellar/libtiff/4.0.10_1: 246 files, 3.5MB
 ==> Installing ghostscript
 ==> Downloading https://homebrew.bintray.com/bottles/ghostscript-9.26_1.high_sierra.bottle.tar.gz
 ################################################################## 100.0%
 ==> Pouring ghostscript-9.26_1.high_sierra.bottle.tar.gz
 ?  /usr/local/Cellar/ghostscript/9.26_1: 668 files, 81.1MB
 ==> Downloading http://mirror.ctan.org/systems/mac/mactex/mactex-20180417.pkg
 ==> Downloading from ftp://ftp.kddilabs.jp/CTAN/systems/mac/mactex/mactex-20180417.pkg
 ################################################################## 100.0%
 ==> Verifying SHA-256 checksum for Cask 'mactex'.
 ==> Installing Cask mactex
 ==> Running installer for mactex; your password may be necessary.
 ==> Package installers may write to any location; options such as --appdir are ignored.
 Password:

mactexのインストールが始まると、パスワードを聞かれるので入力します。ここからもさらに時間がかかります……。

installer: Package name is MacTeX-2018
 installer: choices changes file '/var/folders/tg/lt98nx792tj67l35cv39860c0000gn/T/choices20190317-6954-hjcb0m.xml' applied
 installer: Installing at base path /
 installer: The install was successful.
 ?  mactex was successfully installed!

これでTeXのインストールができました。
ここまでで以下のものがインストールされています。

• TeX Live-2018
• GUIアプリケーション
  • BibDesk
  • LaTeXiT
  • TeX Live Utility
  • TeXShop

TeX Liveのアップデート

tlmgrコマンドでインストールしたTeX Liveをアップデートしておきます。
brewコマンドを実行したターミナルだと、環境変数が更新されていないのでtlmgrコマンドにパスが通っていません。新しいターミナルを開くと環境変数が設定されるので、新しいターミナルで以下のコマンドを実行します。

$ sudo tlmgr update --self --all

これもまたかなり時間がかかります…。のんびり待ちましょう。

紙サイズのデフォルト設定

紙のサイズのデフォルト設定をやっておきます。ここではA4に設定しています。

$ sudo tlmgr paper a4

ここまででTeXのインストール、設定は完了です。時間はかかるものの、非常に簡単で助かりますね。学生時代にTeX環境整えるのにヒイコラ言っていたのからすると、ありがたやありがたや…。

SphinxからPDFを生成してみる

TeXの設定が終わったら、SphinxからPDFが生成できるようになっています。
Sphinxのディレクトリで以下のコマンドを実行します。

$ make latexpdf

問題なければ、build先にlatexフォルダが作られ、TeX関連ファイルとPDFファイルが生成されます。

以上です。