SphinxでLuaLaTeX + jlreqできない？

[shotakaha]

やりたいこと

• Sphinxを使って日本語ドキュメントを作成したい
• LuaLaTeX（エンジン）とjlreq（ドキュメントクラス）を使ってビルドしたい

できないこと

• jlreqのオプションを指定する方法がなさそう

調べること

• Sphinxのソースを確認しながら、設定する方法がないか調べる
• 設定する方法がないなら、どうすれば設定できるのか、検討する

[shotakaha]

• SphinxのLaTeX設定の基本を確認した
• Options for LaTeX outputとLaTeX customizationを読んだ
• 日本語訳もあった
  • LaTeX出力のオプション
  • LaTeXのカスタマイズ

エンジンの設定

• エンジンはlatex_engineで指定できる
• language="ja"の時のデフォルトはuplatex、その他の場合はpdflatexに設定される
• 今回はLuaLaTeXを使いたいのでlualatexを指定した

latex_engine = "lualatex"

[shotakaha]

• ドキュメントクラスを設定する（ちょっと複雑）
• 以下の3つの変数が関係する

1. latex_documents
2. latex_theme
3. latex_docclass

[shotakaha]

latex_documents

• latex_documentsには次の値を指定できる
  • startdocname
  • targetname
  • title
  • author
  • theme
  • toctree_only
• この変数はデフォルト値で問題なさそう。conf.pyにも書かなくてOK
• themeはlatex_themeで定義した名前から指定する

[shotakaha]

latex_theme

• デフォルトはmanual or howtoになっている
• manual
  • 日本語: jsbookに相当
  • 他言語: reportに相当
• howto
  • 日本語: jreportに相当
  • 他言語: articleに相当
• デフォルトはmanualに設定されている

[shotakaha]

latex_docclass

• latex_themeのmanualとhowtoをマッピングする辞書型の変数
• latex_docclassを書き換えて、任意のドキュメントクラスを指定できる
• manualをjlreqで上書きするだけでよさそう

latex_docclass = {"manual": "jlreq"}

[shotakaha]

jlreqのドキュメントクラスオプション

• jlreqで文書スタイルを指定できるとよい
• ドキュメントクラスオプションにreportやbookを追加できないか
• Sphinxを通して、次のような設定ができるとよい

\documentclass{jlreq}          % article
\documentclass[report]{jlreq}  % report
\documentclass[book]{jlreq}    % book

[shotakaha]

やってみた

• conf.pyのlatex_engineとlatex_docclassを次のように指定した

# conf.py
latex_engine = "lualatex"
latex_docclass = {"manual": "jlreq"}

• このままmake latexpdfするとエラーになった
• make latexしてLaTeXファイルの中身を直接確認する

$ make latexpdf # <- エラー; PDFがビルドできない
$ make latex

[shotakaha]

make latexpdfするとエラーになる

は間違いだったかも。
いま実行したらエラーにならなかった。

[shotakaha]

PDFの目次が表示されない

[shotakaha]

extraclassoptions

• ドキュメントクラスのオプションはextraclassoptionsで追加できる

latex_elements = {
  ...
  "extraclassoptions": "extra1,extra2",
  ...
}

[shotakaha]

• デフォルトのオプション（papersize、pointsize）は削除できないみたい
• いまのSphinx (v5.1) の仕様ではjlreqを使うことができなさそう

[shotakaha]

• ドキュメントクラスのオプションがすべて、extraclassoptionsで設定できるようになっていればハッピーなんだろうか？

[shotakaha]

別のドキュメントクラスを使う

• jlreqが使えないことが分かったが、lualatexは使いたい
• ドキュメントクラスをltjsreportにすればよさそう

latex_engine = "lualatex"
latex_docclass = {
  "howto": "ltjsreport",
  "manual": "ltjsreport",  # 必要なら ltjsbook に変更する
}

latex_elements = {
  "papersize": "a4paper",
  "pointsize": "12pt",
  # "extraclassoptions": "tombow",
  ...,
}