ラテックスカスタマイズ

似ていない the HTML builders vt.的 latex Builderは準備されたテーマから利益を得ないだろう。♪the LaTeX出力オプション 特に、特に latex_elements 変数は，カスタムに多くのインタフェースを提供する.例：

# inside conf.py
latex_engine = 'xelatex'
latex_elements = {
    'fontpkg': r'''
\setmainfont{DejaVu Serif}
\setsansfont{DejaVu Sans}
\setmonofont{DejaVu Sans Mono}
''',
    'preamble': r'''
\usepackage[titles]{tocloft}
\cftsetpnumwidth {1.25cm}\cftsetrmarg{1.5cm}
\setlength{\cftchapnumwidth}{0.75cm}
\setlength{\cftsecindent}{\cftchapnumwidth}
\setlength{\cftsecnumwidth}{1.25cm}
''',
    'fncychap': r'\usepackage[Bjornstrup]{fncychap}',
    'printindex': r'\footnotesize\raggedright\printindex',
}
latex_show_urls = 'footnote'

注釈

Python文字列の逆スラッシュは、変換シーケンスとして解釈されないように2倍にしなければならないことを覚えておいてください。あるいは、上述したように元の文字列を使用することもできます。

♪the latex_elements 設定を構成する

ラテックス断片を含む辞書は通常Sphinxをカバーして生成されます .tex ファイルです。ITS.ITS 'sphinxsetup' キーワードを記述しています separately それがそうです。

カバーしたいキーワードは

'papersize'

文書類の紙サイズオプション ('a4paper' あるいは…。 'letterpaper' ）

デフォルト： 'letterpaper'

'pointsize'

Point size option of the document class ('10pt', '11pt' or '12pt')

デフォルト： '10pt'

'pxunit'

の値です。 px 画像属性で使用する場合 width そして height それがそうです。デフォルト値は '0.75bp' それは実現しました 96px=1in (tex単位で) 1in = 72bp = 72.27pt ()例えば得られるのは 100px=1in 使用 '0.01in' あるいは…。 '0.7227pt' (後者は、仕様で使用される単位が小さいので、tex計算のより正確な値をもたらす)。 72px=1in 使用するだけで '1bp' 何のために？ 90px=1in 使用 '0.8bp' あるいは…。 '0.803pt' それがそうです。

デフォルト： '0.75bp'

バージョン 1.5 で追加.

'passoptionstopackages'

プリアンブルの前に位置する文字列を、含まれるように設計します \\PassOptionsToPackage{{options}}{{foo}} 命令する。

デフォルト： ''

バージョン 1.4 で追加.

'babel'

“バベルタ”パッケージには、デフォルトが含まれています。 '\\usepackage{{babel}}' (適切な文書言語文字列はクラスオプションとして渡され、 english 言語がなければ使います。)日本語文書に対しては，デフォルト値は空文字列である.

XeLaTeXとLuaLaTeXを用いて，SphinxはLaTeX文書を構成して使用する polyglossia しかし今の状況では babel 近年、私はunicodeエンジンのサポートを改善し、いくつかの言語の場合、unicodeエンジンをサポートする傾向があるかもしれません。 babel 超過 polyglossia それがそうです。

ヒント

このようにコアLaTeX鍵を修正した後，次のPDF構築前にLaTeX構築ライブラリをクリーニングし，そうでなければ残された補助ファイルが構築を破壊する可能性がある.

Default: '\\usepackage{babel}' ('' for Japanese documents)

バージョン 1.5 で変更: 上の latex_engine とする. 'xelatex' デフォルト値は '\\usepackage{{polyglossia}}\n\\setmainlanguage{{<language>}}' それがそうです。

バージョン 1.6 で変更: 'lualatex' uses same default setting as 'xelatex'

バージョン 1.7.6 で変更: フランス語では xelatex そして lualatex デフォルトで使用する babel やめて！ polyglossia それがそうです。

'fontpkg'

フォントバッグには含まれています。デフォルト設定は '\\usepackage{{times}}' テキストをTimes，Helveticaを用いて無ライニング，Courierを用いて等幅を表す.

英語やラテンヨーロッパ言語の文書では、時々シリエル文字を使用することをサポートするために、デフォルト設定(Σωματ≡δακ≡σκﾟ)を強化し、デフォルト設定(Σωματ≡δακ≡σκﾟ)を強化します。 'pdflatex' エンジン)やるべきこと：

\substitutefont{LGR}{\rmdefault}{cmr}
\substitutefont{LGR}{\sfdefault}{cmss}
\substitutefont{LGR}{\ttdefault}{cmtt}
\substitutefont{X2}{\rmdefault}{cmr}
\substitutefont{X2}{\sfdefault}{cmss}
\substitutefont{X2}{\ttdefault}{cmtt}

以下の条件を満たす場合にのみ活性化される. 'fontenc' キーはロードするように構成されている LGR (ギリシャ語)および/または X2 (シリルヴィン)PDFプレーンフォントコード(場合) language シリルヴァンに設定すれば 'fontpkg' “Times”パケットはそれを直接サポートしないので、鍵を使用しなければならない。その後、保持するだけである。 LGR テキスト中のギリシャ語をサポートする必要がある場合は、上の行を使用してください)。

♪the \substitutefont コマンドはSphinxと同名のLaTeXパケットから来ており、必要であればSphinxはこのパケットをロードする(Ubuntu Xenialでは、それは texlive-latex-extra これはライオンの顔像の要求です)

Only if the document actually does contain Unicode Greek letters (in text) or Cyrillic letters, will the above default set-up cause additional requirements for the PDF build. On Ubuntu Xenial, these are the texlive-lang-greek, texlive-lang-cyrillic, and (with the above choice of fonts) the cm-super (or cm-super-minimal) packages.

上の 'xelatex' そして 'lualatex' このOpenTypeフォントシリーズは、FreeFontシリーズをデフォルトで使用しています：このOpenTypeフォントシリーズは、シリルヴァンおよびギリシャ文をサポートしており、別個のUbuntu Xenialパッケージとして提供することができます。 fonts-freefont-otf それがそうです。もっと大きなものをインストールする必要はありません texlive-fonts-extra 小包です。

'platex' エンジンは、追加のユーザー設定を必要としない単一のシリル文字およびギリシャ文字をサポートします。

デフォルト： '\\usepackage{{times}}' (または) '' シリルヴァンを使う時)

バージョン 1.2 で変更: 黙認する. '' 当たる language シリル文字を使います。

バージョン 2.0 で変更: ギリシャ語とシリルヴィン文字のサポートを追加しました

'fncychap'

“fncychap”バッグが含まれています '\\usepackage[Bjarne]{{fncychap}}' 英語文書(このオプションはSphinxによって少しカスタマイズされている)については、 '\\usepackage[Sonny]{{fncychap}}' 国際化文書(“Bjarne”様式は英語綴りの数字を使用しているため)。他にも試してみることができる“fncychap”スタイルには、“Lenny”、“Glenn”、“Conny”、“Rejne”、“Bjornstrup”があります。これを設定することもできます '' FncyCHAPを無効にするには、以下の操作を実行してください。

デフォルト： '\\usepackage[Bjarne]{{fncychap}}' 英語の文書では

'\\usepackage[Sonny]{{fncychap}}' 国際化された文書や '' 日本語の書類です。

'preamble'

プリアンブル内容を付加する。ユーザはすべての必要なマクロをあるファイルに移動することができる. mystyle.tex.txt プロジェクトソースライブラリ、LaTeXに実行時に導入させます：

'preamble': r'\input{mystyle.tex.txt}',
# or, if the \ProvidesPackage LaTeX macro is used in a file mystyle.sty
'preamble': r'\usepackage{mystyle}',

そしてそれを適切に設定する必要があります latex_additional_files 例えば、：

latex_additional_files = ["mystyle.sty"]

デフォルト： ''

'figure_align'

ラテックス図形の浮動整列。1つの画像が現在のページに適合していない場合、次のページに“浮動”されるが、前には他のテキストがある可能性がある。この行為が気に入らない場合は、“H”を使用してください。これは浮動小数点を無効にし、図形がソースコードに現れる順に図形を厳密に特定します。

デフォルト： 'htbp' (ここでは、上部、下部、ページ)

バージョン 1.3 で追加.

'atendofbody'

文書の内容(インデックスの直前)を付加する.

デフォルト： ''

バージョン 1.5 で追加.

'extrapackages'

追加のラテックス包装。例：

latex_elements = {
    'packages': r'\usepackage{isodate}'
}

指定されたLaTeXパケットは，HyperrefパケットとSphinx Extensionsからロードされたパケットの前にロードされる.

ヒント

Hyperrefの後に追加のLaTeXパッケージをロードしたい場合は、ご利用ください 'preamble' 代わりに鍵がある。

デフォルト： ''

バージョン 2.3 で追加.

'footer'

フッタの内容(インデックスの前)を付加する.

デフォルト： ''

バージョン 1.5 で非推奨: 使用 'atendofbody' 代わりに鍵がある。

特別な場合でなければ、オーバーレイが必要とされないキーは、以下のことを含む。

'extraclassoptions'

デフォルト値は空文字列である.例： 'extraclassoptions': 'openany' 章を許可します 'manual' キー入力)は任意のページから開始することができる.

デフォルト： ''

バージョン 1.2 で追加.

バージョン 1.6 で変更: このドキュメントを追加しました。

'maxlistdepth'

LaTeXはデフォルトでネストリストと類似参照環境を最大6レベル，最大4個の列挙リスト，および4つの項目記号リストを許可する.例えば、このキーは、 '10' (文字列として)最大10個のネストレベル(全タイプ)が許容されます。これを空文字列として保持することは、LaTeXのデフォルト設定に準拠することを意味する。

警告

  • このキーを用いると，あるLaTeXパッケージや自分でリストカスタマイズを行った特殊な文書類と互換性がないことが証明される可能性がある.

  • 秘密鍵をサイレントに設定する 無視する. もし \usepackage{{enumitem}} 文書プリアンブルで実行される.では、このLaTeXパッケージの専用命令を使いましょう。

デフォルト： 6

バージョン 1.5 で追加.

'inputenc'

“inputenc”パッケージに含まれています。

デフォルト： '\\usepackage[utf8]{{inputenc}}' Pdflatexを使用する場合、そうでなければ

''

バージョン 1.4.3 で変更: 先に '\\usepackage[utf8]{{inputenc}}' すべてのコンパイラに用いられる.

'cmappkg'

“Cmap”パッケージに含まれています。

デフォルト： '\\usepackage{{cmap}}'

バージョン 1.2 で追加.

'fontenc'

“fontenc”パッケージに含まれています。

もし 'pdflatex' はい。 latex_engine 追加できます LGR 文書のギリシャ文字をサポートしています X2 (または) T2A )シリルヴィン文字については、以下のようになる。

r'\usepackage[LGR,X2,T1]{fontenc}'

注意

ギリシャ語が主な言語なら、このキーを使わないでください。スフィンクス2.2.1から xelatex 自動的に使います latex_engine それがそうです。従来，Sphinxはギリシャ語を主言語としたLaTeXによるPDF生成をサポートしていなかった.

2.0までUnicodeギリシャ文字はLaTeX数学表記を使用するように変換された。今はそうではありませんが、上の説明を使わなければなりません(以下の場合のみ 'pdflatex' エンジン)、ソースがそのようなUnicodeギリシャ語を含む場合。

Ubuntu異種について、ソフトウェアパッケージ texlive-lang-greek そして cm-super (後者の場合は 'fontpkg' 設定はそのデフォルト値に保存する必要があります LGR 仕事に行きます。代わりに cm-super もっと小さいのをインストールすることができます cm-super-minimal しかしLaTeX文書を実行する必要があります \usepackage[10pt]{{type1ec}} 積み込み前 fontenc それがそうです。したがって，必要であれば，開始時にこのキーとこの余分なキーを用いることができる.

デフォルト： '\\usepackage[T1]{{fontenc}}'

バージョン 1.5 で変更: 黙認する. '\\usepackage{{fontspec}}' 当たる latex_engine はい。 'xelatex' それがそうです。

バージョン 1.6 で変更: 'lualatex' 用途 fontspec デフォルト設定によると、同様に 'xelatex' それがそうです。

バージョン 2.0 で変更: 'lualatex' 執行する． \defaultfontfeatures[\rmfamily,\sffamily]{{}} Tex連字変換を無効にする << そして >> 逃避と pdflatex/xelatex 失敗し，過ちを犯す. lualatex それがそうです。

バージョン 2.0 で変更: Detection of LGR, T2A, X2 to trigger support of occasional Greek or Cyrillic ('pdflatex' only, as this support is provided natively by 'platex' and only requires suitable font with 'xelatex'/'lualatex').

バージョン 2.3.0 で変更: 'xelatex' また実行します \defaultfontfeatures[\rmfamily,\sffamily]{{}} 宮縮を避けるために -- PDFでは(非文字テキスト段落で)短い線に変換したり、まっすぐな引用符をカール引用符に変換したりしますが、 smartquotes 設定は False それがそうです。

'textgreek'

これは必要です pdflatex φφ≡≡などのギリシャ文字をサポートするUNICODEを入力します。専門家ユーザーはロードを望んでいるかもしれません textalpha ソフトウェアパッケージとそのオプション normalize-symbols それがそうです。

ヒント

中のUnicodeギリシャ語(ただし他のUnicode符号はない) math 以下のようにサポートすることができる 'pdflatex' この鍵を設定してから r'\usepackage{{textalpha,alphabeta}}' それがそうです。それで？ :math:`α (U+03 B 1)は :math:alpha` それがそうです。数学入力におけるより広範なUnicodeサポートについては、参照 latex_engine それがそうです。

使用 'platex' (日本語)、 'xelatex' あるいは…。 'lualatex' このキーは無視する.

デフォルト： '\\usepackage{{textalpha}}' あるいは…。 '' もし fontenc ダメだ

含める LGR 選択します。

バージョン 2.0 で追加.

'geometry'

GEOMETRY“パッケージは、デフォルトで定義されています。

'\\usepackage{geometry}'

追加のものを追加します [dvipdfm] 日本語の書類です。Sphinx LaTeXスタイルファイル実行：

\PassOptionsToPackage{hmargin=1in,vmargin=1in,marginpar=0.5in}{geometry}

それに応じた 'sphinxsetup' options それがそうです。

デフォルト： '\\usepackage{{geometry}}' (または)

'\\usepackage[dvipdfm]{{geometry}}' (日本語文書に適用)

バージョン 1.5 で追加.

バージョン 1.5.2 で変更: dvipdfm 以下の場合のオプション latex_engine はい。 'platex' それがそうです。

バージョン 1.5.3 で追加: ♪the 'sphinxsetup' keys for the margins それがそうです。

バージョン 1.5.3 で変更: LaTeXファイルの位置は \usepackage{{sphinx}} そして \sphinxsetup{{..}} そのため挿入されています 'fontpkg' 鍵です。これは，日本語文書を特殊に扱うための紙レイアウトオプションであり，テキスト幅は以下のように設定される. 禅カー庫 幅は，テキスト高さをベースラインの整数倍に設定する.ご参照ください hmargin より多くの情報については、文書を参照してください。

'hyperref'

“Hyperref”パッケージには、パッケージ“hallcap”や問題も含まれています \urlstyle{{same}} それがそうです。これは以下の時間の後に完成します sphinx.sty ファイルがロードされ、実行されています 'preamble' 鍵です。

注意

“HYPERREF”と“HIPCAP”をロードしなければなりません。

バージョン 1.5 で追加: 以前、これは内部から行われていた。 sphinx.sty それがそうです。

'maketitle'

“Make Title”電話です。異なるスタイルのバナーページを生成する場合は、このオプションを上書きしてください。

ヒント

鍵値が設定されていれば r'\newcommand\sphinxbackoftitlepage{{<Extra material>}}\sphinxmaketitle' そして、そして <Extra material> バナーページの裏に組み版する ('manual' Docclassのみ).

デフォルト： '\\sphinxmaketitle'

バージョン 1.8.3 で変更: 原始 \maketitle From Documentクラスは上書きされないため，そのキーの何らかのカスタマイズ設定の一部として再利用することができる.

バージョン 1.8.3 で追加: \sphinxbackoftitlepage マクロを選ぶことができる。内部で定義することもできます 'preamble' これではなく鍵です。

'releasename'

接頭辞の値 'release' 見出しページの要素ですそこまでは タイトル そして 作者 タプルで使用されています latex_documents これはLaTeXタグとして挿入される.

デフォルト： 'Release'

'tableofcontents'

“Table Of Contents”呼び出し。デフォルト設定は '\\sphinxtableofcontents' 未修正の \tableofcontents それ自体は、ユーザによってロードされたパケットによってカスタマイズされてもよい。異なるディレクトリを生成する場合や、バナーページとディレクトリの間にコンテンツを置く場合は、このオプションを上書きしてください。

デフォルト： '\\sphinxtableofcontents'

バージョン 1.5 で変更: 昔の意味は \tableofcontents それ自体がライオンのイメージに改造されていますこれはまた、“tocoft”や“etc”のような専用パケットを修正することと互換性がない。

'transition'

トランジションを表示するためのコマンド。遷移を異なる方法で表示する場合は、上書きしてください。

デフォルト： '\n\n\\bigskip\\hrule\\bigskip\n\n'

バージョン 1.2 で追加.

バージョン 1.6 で変更: 不要な内容を削除する {{}} その後 \\hrule それがそうです。

'printindex'

“printindex”は、ファイルの最後の項目を呼び出します。インデックスを異なる方法で生成したり、インデックスの後に追加したりする場合は、上書きしてください。例えば '\\footnotesize\\raggedright\\printindex' インデックスに長いエントリがいっぱいになっている場合は、使用を推奨します。

デフォルト： '\\printindex'

'fvset'

カスタマイズ fancyvrb ラテックス包装。デフォルト値です。 '\\fvset{{fontsize=\\small}}' コードブロックで使用される等幅フォントの大きな文字幅を調整するために用いられる.カスタムフォントを使用する場合、この設定を修正する必要がある場合があります。

デフォルト： '\\fvset{{fontsize=\\small}}'

バージョン 1.8 で追加.

バージョン 2.0 で変更: 新しいデフォルトフォントが選択されたので 'xelatex' そして 'lualatex' (FreeFont)、Sphinx \\fvset{{fontsize=\\small}} これらのエンジンを使うこともできます \\fvset{{fontsize=auto}} ）。

他のオプションによって設定されているので、カバーされてはいけないポイントは、

'docclass' 'classoptions' 'title' 'release' 'author' 'makeindex'

♪the sphinxsetup 設定を構成する

バージョン 1.5 で追加.

♪the 'sphinxsetup' のキーワードです。 latex_elements ラテックス型カスタマイズインタフェースを提供する：

latex_elements = {
    'sphinxsetup': 'key1=value1, key2=value2, ...',
}

黙認が空である。空でなければパラメータとして \sphinxsetup 文書のはじめのマクロは，以下のとおりである.

\usepackage{sphinx}
\sphinxsetup{key1=value1, key2=value2,...}

以上で使用した色は svgnames “xcolor”パッケージのオプション：：

latex_elements = {
    'passoptionstopackages': r'\PassOptionsToPackage{svgnames}{xcolor}',
}

さらに挿入することができます \sphinxsetup LaTeXマクロを文書本文に直接入れて raw 指令する。本章では，PDF出力に章の冒頭の以下の設定スタイルを用いる.

.. raw:: latex

   \begingroup
   \sphinxsetup{%
         verbatimwithframe=false,
         VerbatimColor={named}{OldLace},
         TitleColor={named}{DarkGoldenrod},
         hintBorderColor={named}{LightCoral},
         attentionborder=3pt,
         attentionBorderColor={named}{Crimson},
         attentionBgColor={named}{FloralWhite},
         noteborder=2pt,
         noteBorderColor={named}{Olive},
         cautionborder=3pt,
         cautionBorderColor={named}{Cyan},
         cautionBgColor={named}{LightCyan}}

本章の末尾には以下が含まれる.

.. raw:: latex

   \endgroup

LaTeXブールキーは 小文字 true あるいは…。 false 価値観。コンマや等号の周囲のスペースは無視され，LaTeXマクロ内のスペースが重要である可能性がある.

hmargin, vmargin

水平線のサイズ(それぞれ垂直なページの辺の距離として hmargin (返事してください。 vmargin )へのオプションの追加 geometry 小包です。例：：

'sphinxsetup': 'hmargin={2in,1.5in}, vmargin={1.5in,2in}, marginpar=1in',

日本語文書は現在，これらのパラメータの1次元フォーマットのみを受け取っている.♪the geometry そして，テキスト幅を設定するために適切なオプションをパケットに渡す 禅カー庫 幅，テキスト高さはベースラインジャンプの整数倍に設定し，ページエッジ距離に最適である.

デフォルト： 1in (相当) {{1in,1in}} ）

ヒント

日本語上の 'manual' PointSizeを持つdocclass 11pt あるいは…。 12pt 使用、使用 nomag 添付ドキュメント·クラス·オプション(参照) 'extraclassoptions' のキーワードです。 latex_elements )またはいわゆるtex“true”単位：

'sphinxsetup': 'hmargin=1.5truein, vmargin=1.5truein, marginpar=5zw',

バージョン 1.5.3 で追加.

marginpar

♪the \marginparwidth ラテックスサイズです。日本語文書に対しては，この値を修正する 禅カー庫 幅です。

デフォルト： 0.5in

バージョン 1.5.3 で追加.

verbatimwithframe

ブール値は、あるかどうかを指定するための code-block sと文字包含はともにフレームである.これを false オプションのバックライトに使用されているので、“FRAM ED”を使い続けている。

デフォルト： true それがそうです。

verbatimwrapslines

ブール値は、あるかどうかを指定するための code-block その内容は包装されています。

デフォルト： true

literalblockcappos

タイトル位置を決定する： b (“底”)または t (“トップ”)

デフォルト： t

バージョン 1.7 で追加.

verbatimhintsturnover

コードブロックがページ分け時に“次のページ継続”と“前ページから継続”が提示されるブール値を表示するかどうかを指定するために用いられる.

デフォルト： true

バージョン 1.6.3 で追加.

バージョン 1.7 で変更: デフォルト設定から false 至る true それがそうです。

verbatimcontinuedalign, verbatimcontinuesalign

フレームワークの内容に対する水平位置： l (左揃え)、 r (右整列)または c (真ん中)。

デフォルト： r

バージョン 1.7 で追加.

parsedliteralwraps

ブール値は、あるかどうかを指定するための parsed-literal その内容は改行すべきです。

デフォルト： true

バージョン 1.5.2 で追加: このオプションの値を false 以前の行動を回復させることができます

inlineliteralwraps

行内の文字内での改行が許可されているか否かを指定するためのブール値：しかし、現在は文字の後にのみ追加の潜在的なブレークポイント(LaTeXによって許可されているスペースまたは連字のためのブレークポイントを除いて)が挿入されている . , ; ? ! / そして \ それがそうです。Texの内部構造のために、ライン内の空白領域は、改行に適応するために伸張(または縮小)されるであろう。

デフォルト： true

バージョン 1.5 で追加: このオプションの値を false 以前の行動を回復させることができます

バージョン 2.3.0 で変更: 以下の位置に潜在的なブレークポイントを追加しました \ 文字です。

verbatimvisiblespace

長い符号ラインを分割する際には、ソース符号ラインのうち、改行位置の直前の最後のスペース文字がこれを用いてレイアウトされる。

デフォルト： \textcolor{{red}}{{\textvisiblespace}}

verbatimcontinued

連続コード行の先頭に挿入されたLaTeXマクロ.それは(複雑な)デフォルトレイアウトは右側を指す赤いフック：

\makebox[2\fontcharwd\font`\x][r]{\textcolor{red}{\tiny$\hookrightarrow$}}

バージョン 1.5 で変更: 1.4.2では、長い符号ラインの改行が追加されている。継続記号のデフォルト定義は、様々なフォントサイズに適応するために1.5に変更される(例えば、コードブロックは脚注内にあってもよい)。

TitleColor

タイトルの色(パッケージ“titlesec”を用いて構成される)。

デフォルト： {{rgb}}{{0.126,0.263,0.361}}

警告

色設定通過 'sphinxsetup' 従わなければならない color/xcolor 定食 \definecolor 指揮する。

InnerLinkColor

伝達することができます hyperref 以下の項目としての価値 linkcolor そして citecolor それがそうです。

デフォルト： {{rgb}}{{0.208,0.374,0.486}} それがそうです。

OuterLinkColor

A colour passed to hyperref as value of filecolor, menucolor, and urlcolor.

デフォルト： {{rgb}}{{0.216,0.439,0.388}}

VerbatimColor

背景色です code-block s.

デフォルト： {{rgb}}{{1,1,1}} (白)

VerbatimBorderColor

フレームの色。

デフォルト： {{rgb}}{{0,0,0}} (黒)

VerbatimHighlightColor

表示された線の色を強調する。

デフォルト： {{rgb}}{{0.878,1,1}}

バージョン 1.6.6 で追加.

注釈

このカラーキーから，次のすべての他のキーに対して，“color”または“xcolor”と宣言される実際の名前に接頭辞“スフィンクス”が付いている.

verbatimsep

コード行とフレームワークの間の分離.

デフォルト： \fboxsep

verbatimborder

周囲フレームの幅 code-block s.

デフォルト： \fboxrule

shadowsep

コンテンツとフレームワークの分離 contents そして topic 箱です。

デフォルト： 5pt

shadowsize

右側の横方向の“影”の幅。

デフォルト： 4pt

shadowrule

周囲フレームの幅 topic 箱です。

デフォルト： \fboxrule

noteBorderColor, hintBorderColor, importantBorderColor, tipBorderColor

Sphinx LaTeXでは、パターンを設定するための2つの水平ラインの色 note 警告を入力する.

デフォルト： {{rgb}}{{0,0,0}} (黒)

noteborder, hintborder, importantborder, tipborder

2本の水平線の幅。

デフォルト： 0.5pt

warningBorderColor, cautionBorderColor, attentionBorderColor, dangerBorderColor, errorBorderColor

警告枠の色。

デフォルト： {{rgb}}{{0,0,0}} (黒)

warningBgColor, cautionBgColor, attentionBgColor, dangerBgColor, errorBgColor

各警告の背景色。

デフォルト： {{rgb}}{{1,1,1}} (白)

warningborder, cautionborder, attentionborder, dangerborder, errorborder

フレームの幅。

デフォルト： 1pt

AtStartFootnote

ページ底に脚注テキストの先頭，脚注番号の後に挿入されたラテックスマクロ.

デフォルト： \mbox{{ }}

BeforeFootnote

脚注マークの前に挿入されたLaTeXマクロ.デフォルト設定では，その前に可能なスペースを削除する(そうでなければ，Texはそこに改行を挿入する可能性がある).

デフォルト： \leavevmode\unskip

バージョン 1.5 で追加.

HeaderFamily

約束を破る. \sffamily\bfseries それがそうです。タイトルに使用するフォントを設定します。

LaTeXマクロと環境

Here are some macros from the package file sphinx.sty and class files sphinxhowto.cls, sphinxmanual.cls, which have public names thus allowing redefinitions. Check the respective files for the defaults.

宏

  • 文字パターンコマンド：

    • \sphinxstrong,

    • \sphinxbfcode,

    • \sphinxemail,

    • \sphinxtablecontinued,

    • \sphinxtitleref,

    • \sphinxmenuselection,

    • \sphinxaccelerator,

    • \sphinxcrossref,

    • \sphinxtermref,

    • \sphinxoptional それがそうです。

    バージョン 1.4.5 で追加: 使用 \sphinx マクロ名にプレフィックスを付加し，LaTeXパケットと衝突する可能性を制限する.

  • より多くのテキストスタイル：

    • \sphinxstyleindexentry,

    • \sphinxstyleindexextra,

    • \sphinxstyleindexpageref,

    • \sphinxstyletopictitle,

    • \sphinxstylesidebartitle,

    • \sphinxstyleothertitle,

    • \sphinxstylesidebarsubtitle,

    • \sphinxstyletheadfamily,

    • \sphinxstyleemphasis,

    • \sphinxstyleliteralemphasis,

    • \sphinxstylestrong,

    • \sphinxstyleliteralstrong,

    • \sphinxstyleabbreviation,

    • \sphinxstyleliteralintitle,

    • \sphinxstylecodecontinued,

    • \sphinxstylecodecontinues それがそうです。

    バージョン 1.5 で追加: These macros were formerly hard-coded as non customizable \texttt, \emph, etc...

    バージョン 1.6 で追加: \sphinxstyletheadfamily その理由は \sffamily また，表の見出しセルに複数のパラグラフがあることを許す.

    バージョン 1.6.3 で追加: \sphinxstylecodecontinued そして \sphinxstylecodecontinues それがそうです。

    バージョン 3.0 で追加: \sphinxkeyboard

  • \sphinxtableofcontents ：ラッパー(定義が異なる sphinxhowto.cls はい。中 sphinxmanual.cls )の基準 \tableofcontents それがそうです。宏 \sphinxtableofcontentshook その拡張中に実行されるのはその直前です \tableofcontents それは自分で。

    バージョン 1.5 で変更: 以前のことは \tableofcontents ライオンの顔像に修正されました。

    バージョン 2.0 で変更: ハードコードの再定義 \l@section そして \l@subsection 以前は入れていた 'manual' Docclassは後で以下のように実行されます \sphinxtableofcontentshook それがそうです。このマクロも 'howto' Docclassですが、デフォルトの場合は空です。

  • \sphinxmaketitle ：デフォルト設定として使用されます。 'maketitle' latex_elements 鍵です。クラスファイルで定義する sphinxmanual.cls そして sphinxhowto.cls それがそうです。

    バージョン 1.8.3 で変更: 以前は、 \maketitle LaTeXからの文書クラスはSphinxによって修正された。

  • \sphinxbackoftitlepage ：適用可能 'manual' Docclass、それが定義されていれば、 \sphinxmaketitle 決勝戦の前に \clearpage それがそうです。使用 'maketitle' キーや 'preamble' のキーワードです。 latex_elements 追加するカスタム定義は、以下の操作を実行してください \sphinxbackoftitlepage それがそうです。

    バージョン 1.8.3 で追加.

  • \sphinxcite ：標準包装 \cite 参考に供する。

環境.

  • A figure 任意の本文要素を持つオプションの例があるかもしれません。 sphinxlegend 環境です。デフォルト定義問題 \small そして、そして \par それがそうです。

    バージョン 1.5.6 で追加: 以前は、 \small ハードコードはLaex Writerと最後に \par 不足しています

  • 警告に関する環境：

    • sphinxnote,

    • sphinxhint,

    • sphinximportant,

    • sphinxtip,

    • sphinxwarning,

    • sphinxcaution,

    • sphinxattention,

    • sphinxdanger,

    • sphinxerror それがそうです。

    彼らはおそらく \renewenvironment 個別に定義され、その後、1つのパラメータで定義されなければならない(例えば、通知のタイトルである Warning: 上の warning コマンドは，英語が文書言語であれば).それらのデフォルト定義は ライオンの顔像ヘビー級 (最後の5つ)または 獅子面像灯箱 環境は，種類ごとに特定のパラメータ(色，枠の厚さ)を用いて通過できるように構成されている. 'sphinxsetup' 弦楽です。

    バージョン 1.5 で変更: Use of public environment names, separate customizability of the parameters, such as noteBorderColor, noteborder, warningBgColor, warningBorderColor, warningborder, ...

  • ♪the contents 指令(帯) :local: オプション)と topic 指令は環境によって実行される sphinxShadowBox それがそうです。

    バージョン 1.4.2 で追加: 従来のコードはページ分割を許可する環境に再構成されていた.

    バージョン 1.5 で変更: Options shadowsep, shadowsize, shadowrule.

  • 文字ブロック(通過) :: あるいは…。 code-block )は，いずれも以下の方式で実現されている. sphinxVerbatim 環境とは Verbatim カバンからの環境 fancyvrb.sty それがそうです。これには，トップタイトルと長い行の改行の処理と，ページの区切りを許すフレームが付加されている.表で使用している環境は sphinxVerbatimintable (フレームは描画されていませんが、タイトルの追加は許可されています)。

    バージョン 1.5 で変更: Verbatim 保持と fancyvrb.sty (もし) OriginalVerbatim )； sphinxVerbatimintable 表内で使います。

    バージョン 1.5 で追加: Options verbatimwithframe, verbatimwrapslines, verbatimsep, verbatimborder.

    バージョン 1.6.6 で追加: 支持する. :emphasize-lines: 選択権.

    バージョン 1.6.6 で追加: ユーザのLaTeXマクロに暴露することで、フォーマットをカスタマイズしやすくすることができます。 \sphinxVerbatimHighlightLine それがそうです。

  • 参考書目録を使った sphinxthebibliography Pythonモジュールインデックスと通常のインデックスの両方を使用します sphinxtheindex これらの環境は thebibliography 和と別れる theindex 文書類(またはパッケージ)が提供する環境。

    バージョン 1.5 で変更: 以前，原始環境はSphinxによって修正されていた.

雑多で雑多である.

  • この節，小節，...タイトルは使用です 標題秒 張氏. \titleformat 指揮する。

  • For the 'manual' docclass, the chapter headings can be customized using fncychap's commands \ChNameVar, \ChNumVar, \ChTitleVar. File sphinx.sty has custom re-definitions in case of fncychap option Bjarne.

    バージョン 1.5 で変更: 以前、使用していた Fncychap 他のデザインを使うのではなく Bjarne 機能不全。

ヒント

実験特性として、Sphinxは、LaTeXソースファイルとしてユーザ定義テンプレートファイルを使用することができる。 _templates/latex.tex_t あなたのプロジェクトでは。

Additional files longtable.tex_t, tabulary.tex_t and tabular.tex_t can be added to _templates/ to configure some aspects of table rendering (such as the caption position).

バージョン 1.6 で追加: 現在，すべてのテンプレート変数は不安定で文書記録がない.