SphinxにおけるHTML出力の数学的サポート

バージョン 0.5 で追加.

バージョン 1.8 で変更: 非HTMLビルダの数学的サポートはsphinx-coreに統合されている.したがって，数学ライブラリの拡張はもはや必要ではない.

HTML自体は数学表現法をサポートしていないため，Sphinxはいくつかの拡張によりHTML文書に数学的支援を提供している.これらの関数はreStructiredText数学を用いている directive そして role それがそうです。

sphinx.ext.imgmath --数学を画像にレンダリングします。

バージョン 1.4 で追加.

この拡張はLaTeXと dvipng あるいは…。 dvisvgm PNGまたはSVG画像に変換します。もちろん，文書を構築する計算機はこの2つのプログラムを同時に持たなければならないことを意味する.

イメージの構築方法に影響を与える様々な構成値を設定することができます。

imgmath_image_format

画像フォーマットを出力する。黙認する. 'png' それがそうです。それはそうだと思います 'png' あるいは…。 'svg' それがそうです。この画像は，まず以下の操作を行うことで生成される. latex TeX数学表記(要求のフォーマットに依存) dvipng あるいは…。 dvisvgm それがそうです。

imgmath_use_preview

dvipng そして dvisvgm 両方ともLaTeXからレンダリング数学の“深さ”を収集することができますイントラネット画像は vertical-align スタイルは周囲のテキストと正しく整列している.

この仕組みには LaTeX preview package (以下の形式で提供 preview-latex-style Ubuntu Xenial上)。したがって，このオプションのデフォルト値は False しかし強く提案しているのは True それがそうです。

バージョン 2.2 で変更: このオプションは 'svg' imgmath_image_format それがそうです。

imgmath_add_tooltips

デフォルト： True それがそうです。Falseであれば，LaTeXコードを数学画像の“alt”属性に追加しない.

imgmath_font_size

書体の大きさ(in pt ）。デフォルト値は 12 それがそうです。これは正の整数でなければならない。

imgmath_latex

LaTeXを呼び出すための命令名.黙認する. 'latex' 以下の場合、完全パスに設定する必要がある場合があります。 latex 実行可能ファイル検索パスにはない.

この設定はシステム間で移植できないため，中に設定することは通常役に立たない. conf.py それを置いて sphinx-build 命令行通過 -D 以下に示すように、オプションはもっと望ましいべきである。

sphinx-build -b html -D imgmath_latex=C:\tex\latex.exe . _build/html

この値は、他のパラメータではなく、LaTeX実行可能ファイルの経路のみを含むべきである。 imgmath_latex_args この目的のために。

ヒント

いくつかの派手なLaTeXマーク(TikZを使用して等式に様々な装飾を追加する例が報告されている)は、LaTeX実行可能ファイルの複数回の実行を必要とする。この問題に対処するために、この構成を設定してください 'latexmk' このPerlスクリプトは、LaTeXを実行する必要がある回数を確実に動的に選択するので、(またはそれを指す完全パス)。

imgmath_latex_args

LaTeXの他のパラメータはリスト形式で提供される.デフォルト値は空リストです。

imgmath_latex_preamble

数学コードセグメントを変換するためのLaTeXファイルのはじめにLaTeXコードを付加する.デフォルトの場合，このフィールドは空である.例えば、数学的フォントを修正するためのパッケージ、例えば、これを追加するために使用される '\\usepackage{{newtxsf}}' 無裏線フォントの場合、または '\\usepackage{{fouriernc}}' 裏線フォントに使います。実際，デフォルトのLaTeX数学フォントは非常に細いフォントを持ち，(HTML出力では)これらのフォントは通常テキストのフォントとあまり一致しない.

imgmath_dvipng

呼び出す命令名 dvipng それがそうです。黙認する. 'dvipng' 以下の場合、完全パスに設定する必要がある場合があります。 dvipng 実行可能ファイル検索パスにはない.このオプションは以下の場合にのみ使用されます imgmath_image_format とする. 'png' それがそうです。

imgmath_dvipng_args

Dvipngの他のパラメータをリスト形式で提供する.デフォルト値は ['-gamma', '1.5', '-D', '110', '-bg', 'Transparent'] これにより、画像は、デフォルトの場合よりも暗く、大きく(これは、デフォルトLaTeX数学フォントの繊細さをある程度補償する)、透明な背景を有するPNGを生成する。このオプションは以下の場合にのみ使用されます imgmath_image_format はい。 'png' それがそうです。

imgmath_dvisvgm

呼び出す命令名 dvisvgm それがそうです。黙認する. 'dvisvgm' 以下の場合、完全パスに設定する必要がある場合があります。 dvisvgm 実行可能ファイル検索パスにはない.このオプションは以下の場合にのみ使用されます imgmath_image_format はい。 'svg' それがそうです。

imgmath_dvisvgm_args

Dvisvgmの他のパラメータをリスト形式で提供する.デフォルト値は ['--no-fonts'] つまりこれは dvisvgm 字形を経路要素として提示する(参照) dvisvgm FAQ ）。このオプションは以下の場合にのみ使用されます imgmath_image_format はい。 'svg' それがそうです。

sphinx.ext.mathjax --JavaScriptで数学をレンダリングします

バージョン 1.1 で追加.

この拡張は，数学をそのままHTML文書に入れる.JavaScriptバッグ MathJax そして、LaTeXタグをロードしてブラウザ内のリアルタイムで読み取り可能な数学に変換します。

MathJax(および必要なフォント)は非常に大きいため，Sphinxには含まれないが，第三者サイトから自動的に含まれるように設定されている.

注意

You should use the math directive and role, not the native MathJax $$, \(, etc.

mathjax_path

HTMLファイルに含まれるには，MathJaxのJavaScriptファイルをロードするパスである.

デフォルト値は https:// JSファイルのURLをロードする `cdnjs`_ _コンテンツ配信ネットワーク。ご参照ください `MathJax Getting Started page`_ _詳細を知ります。MathJaxオフラインで第三者サイトからのリソースを利用可能または含まないことが望ましい場合には、それをダウンロードし、この値を異なる経路に設定しなければならない。

経路は絶対経路であってもよく、相対経路であってもよく、相対経路である場合は相対経路であってもよい。 _static 文書のディレクトリを構築した.

たとえば，MathJaxをSphinx文書の静的経路に入れると，この値は MathJax/MathJax.js それがそうです。1台のサーバに複数のSphinx文書セットをホストする場合には、MathJaxを共有位置にインストールすることをお勧めします。

完全なものを与えることもできます https:// URLはCDN URLとは異なる.

mathjax_options

Mathjaxのためのスクリプトタグのオプションを作成します。例えば、以下の設定を使用して完全性オプションを設定することができます。

mathjax_options = {
    'integrity': 'sha384-......',
}

デフォルト値が空である. ({{}} ）。

バージョン 1.8 で追加.

mathjax_config

Mathjaxのイントラネット構成オプション。この値を用いたパラメータ MathJax.Hub.Config() それがそうです。もっと情報を知りたいのですが、お読みください Using in-line configuration options それがそうです。

例えば：

mathjax_config = {
    'extensions': ['tex2jax.js'],
    'jax': ['input/TeX', 'output/HTML-CSS'],
}

デフォルト値は空(未構成)である.

バージョン 1.8 で追加.

sphinx.ext.jsmath --JavaScriptで数学をレンダリングします

この拡張の動作方式はMathJax拡張と同様であるが，古いパケットを用いている. jsMath. これは、以下の構成値を提供します。

jsmath_path

HTMLファイルに含まれてJSMathのJavaScriptファイルをロードするパスです。違約はありません。

経路は絶対経路であってもよく、相対経路であってもよく、相対経路である場合は相対経路であってもよい。 _static 文書のディレクトリを構築した.

たとえば，JSMathをSphinx文書の静的経路に入れると，この値は jsMath/easy/load.js それがそうです。1台のサーバに複数のSphinxドキュメントセットをホストする場合には、jsMathを共有場所にインストールすることをお勧めします。