今回は Ubuntu 18.04 LTS を使って、Sphinx の PDF をビルドする方法について。
使った環境は次のとおり。
$ cat /etc/lsb-release DISTRIB_ID=Ubuntu DISTRIB_RELEASE=18.04 DISTRIB_CODENAME=bionic DISTRIB_DESCRIPTION="Ubuntu 18.04.3 LTS" $ uname -r 4.15.0-72-generic
下準備
Sphinx は TeX を使って PDF をビルドするんだけど、TeX Live のパッケージはかなり大きい。 そのため、APT でミラーリポジトリを使えるようにしておいた方が良い。
以下のコマンドを実行すればミラーリポジトリが有効になる。
$ sudo sed -i.bak -e 's%http://[^ ]\+%mirror://mirrors.ubuntu.com/mirrors.txt%g' /etc/apt/sources.list
Sphinx をインストールする
つづいて、Sphinx をインストールする。 最新のバージョンを使いたいので PIP からインストールすることにした。
まずは PIP をインストールする。
$ sudo apt update $ sudo apt -y install \ python3-pip \ python3-setuptools \ python3-wheel
PIP を使って、最新の Sphinx をインストールする。
$ sudo pip3 install sphinx
もし、バージョンが少し古くても構わないのであれば、次のように APT を使ってインストールすることもできる。
$ sudo apt -y install python3-sphinx
Sphinx のプロジェクトを作成する
sphinx-quickstart
コマンドを使ってプロジェクトのテンプレートを作る。
$ sphinx-quickstart
ウィザード形式でプロジェクトの設定を聞かれるので答えていく。
Sphinx のプロジェクトに設定を追加する
日本語を含む PDF をビルドするときは、Sphinx の設定ファイル conf.py
に最低限次の設定をした方が良いようだ。
language = 'ja' latex_docclass = {'manual': 'jsbook'}
TeX Live をインストールする
つづいて、PDF をビルドするのに必要な TeX Live の関連パッケージをインストールする。
$ sudo apt -y install \ texlive-latex-recommended \ texlive-latex-extra \ texlive-fonts-recommended \ texlive-fonts-extra \ texlive-lang-japanese \ texlive-lang-cjk \ latexmk
あとからパッケージが足りなくてつらい思いをしたくないときは、次のようにしてすべてのパッケージを入れてしまっても良い。 ただし、インストールするのにめちゃくちゃ時間がかかる。
$ sudo apt -y install texlive-full
PDF をビルドする
あとは make
コマンドを使って latexpdf
ターゲットを実行するだけ。
$ make latexpdf
実行がおわったら、成果物が入るディレクトリに PDF のファイルができているはず。
$ file _build/latex/*.pdf
_build/latex/example.pdf: PDF document, version 1.5
いじょう。
参考文献
- 作者:もみじあめ
- 発売日: 2020/02/29
- メディア: Kindle版