設定ディレクトリ には必ず conf.py が含まれています。このファイルは “ビルド設定ファイル” と呼ばれていて、Sphinxの入出力の動作をカスタマイズするのに必要な 設定はこのファイルに含まれています。この設定ファイルはPythonのプログラムとして書かれています。
設定ファイルは、ビルド時にPythonコードとして実行されます。 設定ファイルが含まれる フォルダをカレントディレクトリに設定し、:func:execfile を使用してコールされので、 任意の複雑なコードを記述することができます。Sphinxが読み込む際には単純にファイルの 中の名前空間に定義されている名前を使うことで、設定を読み込みます。
詳細に説明するにあたっての注意点を列挙します。
使用したいSphinx拡張のモジュールを指定する配列です。この設定自体は配列で、中に、使用したい拡張モジュールの名前の文字列が含まれます。文字列としてはSphinxに付属のもの( sphinx.ext.* )か、カスタムの拡張機能を指定できます。
もし拡張機能が他のディレクトリにある場合には、confファイルの中で sys.path にパスを追加することで、使用できるようになります。注意すべき点としては、絶対パスを指定しなければならない点です。もし、 設定ディレクトリ からの相対パスが分かっている場合には、以下のように os.path.abspath() を以下のように使用します:
import sys, os
sys.path.append(os.path.abspath('sphinxext'))
extensions = ['extname']
上記のコードでは sphinxext というサブディレクトリに含まれる extname という名前の拡張機能をロードしています。
設定ファイル自身で拡張機能を実装してもかいません。その場合には、 setup() という名前の関数を提供する必要があります。
ソースファイルに付く、ファイル名の拡張子を指定します。ここで指定された名前が末尾に付くファイルだけがソースファイルとして読み込まれます。デフォルトは '.rst' です。
すべてのreSTのソースファイルのエンコーディングを指定します。デフォルトかつ、推奨のエンコーディングは 'utf-8-sig' です。
New in version 0.5.
“マスター”ドキュメントのドキュメント名を指定します。”マスター”ドキュメントには、ルートとなる toctree ディレクティブが含まれます。デフォルトは 'contents' です。
globスタイルのパターンのリストを設定し、ソースファイルの探索時に排除すべきファイルを指定します。これらのパターンは、ソースディレクトリからの相対パスで渡されるソースファイル名に対してマッチします。すべての環境で、ディレクトリの指定として、スラッシュ(/)が使用されます。
サンプルのパターン:
exclude_patterns は、 html_static_path の中の静的ファイルを探索する時にも参照されます。
New in version 1.0.
ディレクトリ内には存在するが、現在はtoctreeに読み込まないドキュメント名のリストです。Sphinxはこのようなファイルがあると、警告を出力しますが、この警告を非表示にしたいときにこの設定を使用します。
Deprecated since version 1.0: 代わりに exclude_patterns を使用してください
ソースファイルの検索から除外したいディレクトリパスの配列です。ソースディレクトリからの相対パスで、このフォルダからの再帰的な検索もされなくなるため、サブディレクトリも検索されません。デフォルトは [] です。
New in version 0.4.
Deprecated since version 1.0: 代わりに exclude_patterns を使用してください
Sphinxが行う再帰的な処理で使用されたくないディレクトリ名のリストです。Sphinxではソースファイルの探索や静的ファイルのコピーなどで、再帰的にディレクトリを探索します。 'CVS' などの、バージョンコントロールのシステムのためのディレクトリを一括で除外したい場合などに便利です。デフォルトは [] です。
New in version 0.5.
Deprecated since version 1.0: 代わりに exclude_patterns を使用してください
New in version 0.5.
追加のSphinxメッセージカタログ( language 参照)を探索するディレクトリを指定します。ここで指定されたパスが、標準の gettext モジュールによって、 sphinx ドメインで検索されます。 ./locale を設定ファイルに指定した場合には、 ./locale/language/LC_MESSAGES/sphinx.mo という場所にメッセージカタログを置かなければなりません。
デフォルトは [] です。
追加のテンプレート(もしくは組み込みのテーマに関するテンプレートをオーバーライトするテンプレート)が含まれているパスのリストです。 コンフィギュレーションディレクトリからの相対パスで設定します。
~sphinx.application.TemplateBridge のインスタンスを返す、呼び出し可能なオブジェクト、もしくはシンプルなクラスをあらわす完全限定名です。このインスタンスはHTMLドキュメントや、その他のビルダーの出力をレンダリングする際に使用されます。現在ではchanges builderに使用されています。テンプレートブリッジはHTMLテーマが使用された場合には、これに対応するように作られるべきです。
読み込まれたすべてのソースファイルの末尾に挿入されるreSturucturedTextの文字列を設定します。この設定を利用すると、文字列置換をすべてのファイルに対して行いたいときに、うまく動作します:
rst_epilog = """
.. |psf| replace:: Pythonソフトウェア財団
"""
New in version 0.6.
読み込まれたすべてのソースファイルの先頭に挿入されるreSturucturedTextの文字列を設定します。
New in version 1.0.
デフォルトの ドメイン を指定します。 None を設定すると、デフォルトドメインを無効にします。デフォルトは 'py' です。ドメイン名が明示的に与えられるか、 default-domain ディレクティブで指定するかに関わらず、他のドメインのオブジェクトにはドメイン名が明示的に付加されるでしょう。たとえば、デフォルトのドメインがCであれば、Pythonの関数は単なる”関数”ではなく、”Python関数”という名前になります。
New in version 1.0.
デフォルトロールとして使用する、reSTロールの名前(組み込み、もしくはSphinx拡張)を設定します。これは `このような` テキストのマークアップに対して適用されます。これは 'py:obj' というものがあれば、 `filter` という関数と、Pythonの “filter” のクロスリファレンスを行います。デフォルトは None で、デフォルトのロールは適用されません。
デフォルトのロールは、reST標準の default-role ディレクティブを使用することによっても個々のドキュメントに対して設定することができます。
New in version 0.4.
Trueが設定されると、警告の内容がビルド済みドキュメントの”システムメッセージ”パラグラフの中に保存されます。この設定に関係なく、 sphinx-build 実行時標準エラー出力には警告が出力されます。
デフォルトは False で 0.5以前の振る舞いを維持するにはこのままにしてください。
New in version 0.5.
ドキュメントが想定しているSphinxのバージョンを設定します。 '1.1' というような形式で、 メジャー.マイナー というバージョン文字列を設定すると、Sphinxは自分のバージョンとの比較を行い、もしもバージョンが古すぎる場合にはビルドを中止します。デフォルトでは、チェックをしないようになっています。
New in version 1.0.
ドキュメントを書いているプロジェクト名です。
'2008, Author Name' という形式の著作権表記です。
主要なプロジェクトのバージョンです。 |version| と置換されます。例えば、Pythonのドキュメントであれば、これは 2.6 になります。
完全なプロジェクトのバージョンです。HTMLのテンプレートなどの中の |release| と置換されます。例えば、Pthonのドキュメントの場合には、 2.6.0rc1 のような文字列になります。
ドキュメントの言語のコードです。Sphinxが自動的に生成する文章が、その言語で出力されるようになります。LaTeXビルダーでは Babel パッケージのオプションとして、適切な言語が選択されます。デフォルトは None で翻訳はされません(訳注:英語で出力されます)
New in version 0.5.
現在は以下の言語をサポートしています:
これらの値は現在の日付をどのようにフォーマットするのか、というものを決めます。これは |today| を置き換える時に使用されます。
デフォルトでは、 today は空で、 today_fmt には '%B %d, %Y' という値が設定されています。もしも language が設定されていて、翻訳機能が有効になっている場合には、選択された言語の %format が使用されます。
ドキュメント内でハイライトするデフォルトの言語を設定します。デフォルト値は 'python' です。値はPygmentsのlexer名として有効な名前でなければなりません。詳しくは コードサンプルの表示 を参照してください。
New in version 0.5.
Pygmentsがソースコードをハイライトする際に使用するスタイルの名前を設定します。デフォルトのスタイルはHTMLの出力のテーマで指定されたものになります。そうでない場合には 'sphinx' になります。
Changed in version 0.3: もし値として、Pygmentsのカスタムスタイルクラスの完全限定名が指定されると、カスタムスタイルとして使用されます。
関数とメソッドのロールテキストにカッコを付加するかどうかを決めるブール値です。ロールテキストというのは func:`input` の input の箇所で、これをTrueにすると、その名前が呼び出し可能オブジェクトであるということが分かるようになります。デフォルトは True です。
モジュール定義がされている場所にある、 function などの オブジェクト 名のタイトルのすべてに、モジュール名を付けるかどうかを決めるブール値です。デフォルトは True です。
moduleauthor と sectionauthor ディレクティブの出力を、ビルドしたファイルに含めるかどうかのブール値です。
モジュールのインデックスをソートする際に、無視するプリフィックスのリストです。例えば、 ['foo.'] が設定されると、 foo.bar に関しては foo. が削除されて bar になるため、 F ではなく、 B の項目として表示されます。プロジェクトの中のひとつのパッケージについてドキュメントを書く際にこの機能は便利に使えるでしょう。現在はHTMLビルダーについて使用されています。デフォルトは [] です。
New in version 0.6.
脚注参照の前のスペースをトリムします。スペースはreSTパーサーが脚注を見分けるためには必要ですが、出力されると見た目があまり良くありません。
New in version 0.6.
これらのオプションはHTMLと、HTMLヘルプ出力、SphinxのHTMLWriterクラスを利用しているその他のビルダーに対して影響を与えます。
HTML出力で使用される”テーマ”です。詳しくは テーマに関するセクション を参照してください。デフォルト値は 'default' です。
New in version 0.6.
選択したテーマのルックアンドフィールの設定を行うためのオプションのための辞書です。どのようなオプションがあるかは、テーマごとに異なります。組み込みのテーマで提供されるオプションに関しては、 こちらのセクション を参照してください。
New in version 0.6.
カスタムテーマを含むパスへのリストです。パスはテーマを含むサブディレクトリか、もしくはzipファイルを指定することができます。相対パスを設定すると、コンフィグレーションディレクトリからの相対パスになります。
New in version 0.6.
HTMLページで使用されるスタイルシートを設定します。ここで指定されたファイル名はSphinxの static/ か、 html_static_path で与えられたパスのどちらかの中になければなりません。デフォルトでは選択されたテーマで提供されるスタイルシートを使用します。テーマで使用しているスタイルシートに対して、要素を追加したり、一部の要素の上書きしたいだけの場合には、テーマで提供されるスタイルシートを @import するようにしてください。
Sphinx自身のテンプレートで生成されるHTMLドキュメントの”タイトル”を指定します。ここで設定された値は、それぞれのページ内の <title> タグに対して追加され、ナビゲーションバーの一番トップの要素として使用されます。デフォルト値は ‘{<project>} v{<revision>} document’ となっています。内部のプレースホルダーは同名のコンフィグ値で置き換えられます。
HTMLドキュメントの短いタイトルを設定します。これはヘッダ内のリンク、HTMLヘルプのドキュメントで使用されます。設定されない場合には、 html_title と同じ値がデフォルトで使用されます。
New in version 0.4.
もし設定されると、ドキュメントのロゴ画像として使用されます。設定値は家像ファイル名でなければなりません。画像ファイルはサイドバーのトップに表示されます。画像サイズの幅は200ピクセル以下にしてください。デフォルト値は None です。
New in version 0.4.1: 画像ファイルはHTML出力時に _static ディレクトリにコピーされます。もし同名のファイルが存在する場合には上書きされます。
もし設定されると、ドキュメントのfaviconとして使用されます。設定値は静的なパスで、画像ファイルの名前でなければなりません。最近のブラウザでは、タブやウインドウ、ブックマークでこのfaviconの画像を利用します。これは 16x16 あるいは 32x32 の大きさの、Windowsの形式のアイコンファイル(.ico)でなければなりません。デフォルト値は None です。
New in version 0.4.
スタイルシートやスクリプトファイルといった、カスタムの静的ファイル類が含まれるパスのリストです。相対パスが設定されると、コンフィグレーションディレクトリからの相対パスとして処理されます。これらのファイルは、テーマが提供する静的ファイルをコピーした後にコピー処理が行われるため、 default.css という名前のファイルがあると、テーマで使用する default.css を上書きしてしまうので注意してください。
Changed in version 0.4: html_static_path で指定されるパスにはサブディレクトリも含めることができます。
Changed in version 1.0: 1.0からは、 html_static_path 内のエントリーに、単独のファイルを入れることができます。
空の文字列以外が設定されると、すべてのページの最下部に挿入される ‘最終更新:’ というタイムスタンプを出力されるためのテンプレートとして使用されます。テンプレートは strftime() で解釈できるフォーマットを指定してください。デフォルトは '%b %d, %Y' (ロケールによって異なります)になります。
Trueが設定されると、 SmartyPants は、印刷上で実体を修正するために引用文とダッシュを変換するのに使用されるでしょう。 デフォルトは True です。
Trueが設定されると、Sphinxはそれぞれの見出しに “パーマリンク” を追加します。マウスをそれぞれのリンクの上に持って行くと、パラグラフサインが表示されます。デフォルトは True です。
New in version 0.6: 以前は常に有効になってました。
カスタムのサイドバーのテンプレートです。設定値は、ドキュメント名をキーに、テンプレート名を値に持つ辞書として設定します。
キーには、globスタイルパターンを含めることができます。この場合、マッチしたすべてのドキュメントには、指定されたサイドバーが設定されます。1つ以上のglobスタイルのパターンがマッチすると、警告が出されます。
辞書の値には、リストか、文字列を設定することができます。
もしも値がリストの場合には、含めるべきサイドバーテンプレートの完全なリストとして使用されます。もしもデフォルトサイドバーのすべて、もしくはいくつかが含まれていたら、それらはこのリストに含められます。
デフォルトサイドバー(どのパターンにもマッチしなかったドキュメントで使用される)としては、以下の設定がされたものとして動作します:
['localtoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html'].
組み込みのサイドバーテンプレートは以下のようにビルドされます:
サンプル:
html_sidebars = {
'**': ['globaltoc.html', 'sourcelink.html', 'searchbox.html'],
'using/windows': ['windowssidebar.html', 'searchbox.html'],
}
これは windowssidebar.html カスタムテンプレートと、クイック検索ボックスをレンダリングし、指定されたドキュメントのサイドバーに組み込みます。その他のドキュメントに関しては、デフォルトサイドバーをビルドします。ただし、ローカルの目次はグローバルな目次に置き換えられます。
New in version 1.0: globスタイルのキーが利用できるようになり、複数のサイドバーが設定できるようになりました。
これらの値は、組み込みの scrolls と haiku テーマのように、設定したテーマによっては効果がありません。
HTMLページにレンダリングする、追加のHTMLテンプレートを指定します。設定値はドキュメント名をキーに、テンプレート名を値に持つ辞書として設定します。
サンプル:
html_additional_pages = {
'download': 'customdownload.html',
}
この設定では、 customdownload.html というテンプレートが download.html というページにレンダリングされます。
Note
Sphinxの昔のバージョンには html_index と呼ばれる値を持っていて、これだけが唯一 “index” ドキュメントのコンテンツを制御する方法でした。もしこの機能を使っていた場合には、 html_additional_pages に index というキーを追加して、それまで使用していたカスタムテンプレートを値として設定します。その後、カスタムテンプレートを下記のように書き換えます:
{% extend "defindex.html" %}
{% block tables %}
... 古いテンプレートの内容 ...
{% endblock %}
真に設定されると、ドメイン限定の索引を通常の索引に追加します。例えば、Pythonドメインの場合には、グローバルなモジュールの索引が該当します。デフォルトでは True です。
この設定値にはブール型か、生成すべき索引名のリストを設定することができます。特定の索引名をしていると、HTMLのファイル名を探しに行きます。例えば、Pythonのモジュール索引は 'py-modindex' という名前を持ちます。
New in version 1.0.
もしTrueに設定されると、HTMLドキュメントにモジュールの索引を挿入します。デフォルトは True です。
Deprecated since version 1.0: html_domain_indices を使用してください。
Trueが設定されると、HTMLドキュメントに索引を追加します。デフォルトは True です。
New in version 0.4.
もしTrueが設定されると、索引が２回作成されます。一つ目は全てのエントリーを含む索引です。2つめは最初の文字ごとにページ分割された索引になります。デフォルトは False です。
New in version 0.4.
Trueに設定されると、 HTMLのビルド時に _sources/name としてreSTのソースファイルが含まれるようになります。デフォルトは True です。
Warning
もしもこの設定値が False に設定されると、 JavaScriptの検索機能を使用したときに、マッチしたドキュメントのタイトルしか表示できなくなります。マッチした文章の内容を表示することはできません。
html_copy_source がTrueに設定されていて、かつ、この設定値もTrueに設定された場合に、サイドバーにreSTのソースファイルへのリンクを表示します。デフォルト値は True です。
New in version 0.6.
もしこの値が空でなかったら、 OpenSearch <http://opensearch.org> の説明ファイルが生成され、すべてのページにこのファイルを参照する <link> タグが含まれるようになります。OpenSearchが検索ページの位置を示すのに、相対パスをサポートしていないので、 この値はこの設定値の値は、これらのドキュメントが提供されるベースのURLにします。最後のスラッシュ(/)は不要です。例えば、Pythonのドキュメントであれば、 "http://docs.python.org" とします。デフォルト値は '' です。
HTMLファイルを生成するときに、ファイル名の末尾に追加される文字列として使用されます。デフォルトでは ".html" となります。
New in version 0.4.
HTMLファイルに対して生成されるリンクの末尾に付けられる文字列です。デフォルト値としては html_file_suffix の値が設定されます。他のウェブサーバのセットアップをサポートする場合などに、別の値を設定することができます。
New in version 0.6.
HTML変換クラスへの完全限定名(FQN)を表す文字列です。これはSphinxの HTMLTranslator のサブクラスです。これはドキュメントツリーをHTMLに変換するのに使用されます。デフォルト値は None で、組み込みのトランスレータが使用されます。
もしTrueに設定されると、 “(C) Copyright ...” という文字列をHTMLのフッターに出力します。デフォルトは True です。
New in version 1.0.
もしTrueが設定されると、 “このドキュメントは Sphinx 0.6.2 で生成しました。” という説明がHTMLのフッターに追加されます。デフォルトは True です。
New in version 0.4.
HTML出力ファイルのエンコーディングを指定します。デフォルトは 'utf-8' です。このエンコーディング名Pythonのエンコーディング指定と、HTMLの charset の両方で使用できる名前でなければなりません。
New in version 1.0.
もし真に設定されると、1つのパラグラフのみを含むリストのアイテムは <p> エレメントを使ってレンダリングされなくなります。これは標準のdocutilsの振る舞いと同じです。デフォルト値は True です。
New in version 1.0.
セクション番号のサフィックスです。デフォルトは ". " です。 " " を指定すると、セクション番号の末尾のピリオドが表示されなくなります。
New in version 1.0.
HTMLヘルプビルダーについて、出力ファイルのベース名を設定します。デフォルト値は 'pydoc' です。
これらのオプションを設定すると、epub出力に影響を与えます。このepubビルダーはHTMLビルダーを継承しているため、HTML出力のオプションも適切に反映されます。いくつか、ビルダーへの影響はないが、 ダブリン・コア・メタデータ の中の値として使用される設定値もあります。
epub出力時のHTMLデータｍで素。デフォルトのテーマは小さい画面サイズで見るような調整がされおらず、HTMLのテーマと同じになっていて、epub出力は賢くありません。デフォルトは 'epub' で、このテーマはビジュアルなための空間を減らすようにデザインされています。
ドキュメントのタイトルです。デフォルトでは html_title オプションと同じですが、epub作成時のみの名前が設定できるようになります。
ドキュメントの著者名です。この設定値はダブリン・コア・メタデータの中に出力されます。デフォルト値は 'unknown' です。
ドキュメントの言語設定です。この設定値はダブリン・コア・メタデータの中に出力されます。デフォルトでは、 language オプションが設定されるか、もしそれも設定されていなければ 'en' になります。
ドキュメントの出版社情報になります。この設定値はダブリン・コア・メタデータの中に出力されます。プロジェクトのホームページなど、なんらかの意味のある文字列を入れることになるでしょう。デフォルト値は 'unknown' です。
ドキュメントの識別子です。この設定値はダブリン・コア・メタデータの中に出力されます。出版物であれば、ISBNコードを入れることになりますが、そうでない場合にはプロジェクトのウェブサイトなどの別のスキーマを使うこともできます。デフォルト値は 'unknown' です。
epub_identifier に使用する、出版物のスキーマです。この設定値はダブリン・コア・メタデータの中に出力されます。出版物であれば、 'ISBN' になります。プロジェクトのウェブサイトのURLを指定するのであれば、 'URL' を使うのが良いでしょう。デフォルト値は 'unknown' です。
ドキュメントのユニークな識別子です。この設定値はダブリン・コア・メタデータの中に出力されます。ランダムな文字列を使うことが出来ます。デフォルト値は 'unknown' です。
Sphinxによって生成されたテキストの前に追加されるファイル群を指定します。ファイル名とタイトルが組になったタプルを含む配列となります。
サンプル:
epub_pre_files = [
('index.html', 'Welcome'),
]
デフォルト値は [] です。
Sphinxによって生成されたテキストの後ろに追加されるファイル群を指定します。ファイル名とタイトルが組になったタプルを含む配列となります。このオプションは、追加のAppendixとして使用されます。デフォルト値は [] です。
buildディレクトリには生成されたりコピーされるが、epubファイルの中には含めないファイルのリストを指定します。デフォルト値は [] です。
toc.ncx という目次ファイルに含める、セクションタイトルの階層数を指定します。1以上の数値でなければなりません。デフォルト値は 3 です。あまり深いと、ユーザが見て辿るのが難しくなることに注意しましょう。
このフラグは、ネストされたTOCのリストがあった時に、同じTOCの要素を再度挿入するかどうか決定します。これを使用すると、章の先頭でナビゲーションしやすくなりますが、ことなった階層のリストがまざってしまうため、わかりにくくなります。デフォルトは True です。
これらのオプションはLaTeX出力に影響を与えます。
この値はドキュメントツリーをどのようにグループ化するかを決定します。これは、 (startdocname, targetname, title, author, documentclass, toctree_only) というタプルのリストでなければなりません。それぞれの項目は次のような意味を持ちます。
New in version 0.3: 6番目の toctree_only が追加されました。現在でも、5要素のタプルを指定することもできます。
このオプションが設定されると、ドキュメントのロゴとして使用されます。指定されるのは、設定ディレクトリからの相対パスの、イメージファイル名でなければなりません。タイトルページのトップに表示されます。デフォルトでは None です。
Trueが設定されると、一番上位のセクションの単位がpartになります。そうでない場合はchapterになります。デフォルトは False です。
New in version 0.3.
すべてのマニュアルのappendixに追加されるドキュメント名のリストです。
Trueが設定されると、ドメインに特化した索引が、全体の索引に追加されます。Pythonのドメインの場合には、グローバルなモジュールの索引が該当します。デフォルトは True です。
html_domain_indices と同じく、この設定値にはブール型か、生成すべき索引名のリストを設定することができます。
New in version 1.0.
Trueが設定されると、モジュールの索引がLaTeXのドキュメントに追加されます。デフォルトでは True です。
Deprecated since version 1.0: latex_domain_indices を使用して下さい。
Trueに設定されると内部参照の後ろにページ参照が追加されます。これはマニュアルを紙に印刷して利用する場合に大変便利です。デフォルトは False です。
New in version 1.0.
Trueに設定されると、リンクの後ろにURLのアドレスが追加されます。これはマニュアルを紙に印刷して利用する場合に大変便利です。デフォルトは False です。
New in version 1.0.
New in version 0.5.
LaTeXのスニペットコードが含まれる辞書です。Sphinxはこれらのスニペットを使って、生成された .tex ファイルの中の要素をオーバーライドします。
Pythonの文字列中のバックスラッシュは、エスケープシーケンスとして解釈されるのを避けるために、2重に書く必要があります。
オーバーライドするキーには、次のようなものがあります:
document classの用紙サイズのオプションです。 'a4paper' か 'letterpaper' が指定できます。デフォルトは 'letterpaper' です。
document classのポイントサイズのオプションです。 '10pt' か '11pt', '12pt' が指定できます。デフォルトは '10pt' です。
“babel” パッケージの挿入をします。デフォルトは '\\usepackage{babel}' です。
フォントパッケージの挿入をします。デフォルトはTimesとHelveticaを使用する '\\usepackage{times}' です。 '' を指定すると、Computer Modernフォントが利用されます。
“fncychap”パッケージの挿入をします。これは”fancy chapter tilte”処理を行います。英語のドキュメントのデフォルトは '\\usepackage[Bjarne]{fncychap}' で、国際化されたドキュメントのデフォルトは '\\usepackage[Sonny]{fncychap}' になります。”Bjarne” は数字を英語表記します。他にも”fncychap”スタイルには、 “Lenny”, “Glenn”, “Conny”, “Rejne” を含めることができます。 '' を指定すると、fncychap処理を無効にすることができます。
前書き(preamble)を追加します。デフォルトでは追加しません。
フッターのコンテンツ(索引の前)を追加します。デフォルトでは追加しません。 Additional footer content (before the indices), default empty.
次のキーは、特別な場合でなければ、オーバーライドする必要はありません:
- 'inputenc'
“inputenc”パッケージを挿入します。デフォルトでは '\\usepackage[utf8]{inputenc}' になります。
- 'fontenc'
“fontenc”パッケージを挿入します。デフォルトでは '\\usepackage[T1]{fontenc}' になります。
- 'maketitle'
“maketitle”呼び出しです。デフォルトでは '\\maketitle' が使用されます。異なるスタイルのタイトルページを生成したい場合には、オーバーライドしてください。
- 'tableofcontents'
“tableofcontents”呼び出しです。デフォルトでは '\\tableofcontents' です。異なるスタイルの目次を生成したい場合や、タイトルページと目次の間に何かコンテンツを追加したい場合にはオーバーライドしてください。
- 'printindex'
“printindex”呼び出しです。ファイルの最後の項目になります。デフォルトでは '\\printindex' になります。異なる索引を生成したい場合や、索引の後に何かコンテンツを追加したい場合にはオーバーライドしてください。
次のようなキーは、他のオプションによって指定されるため、オーバーライドすべきではありません:
'docclass' 'classoptions' 'title' 'date' 'release' 'author' 'logo' 'releasename' 'makeindex' 'shorthandoff'
'howto' と 'manual' から実際にSphinxのクラスとして使われるdocument classへのマッピングをする辞書です。デフォルトでは 'howto' には 'article', 'manual' には 'report' が使われます。
New in version 1.0.
設定ディレクトリからの相対パスのファイル名のリストです。LaTeX出力のビルドが行われる時にビルドディレクトリに出力されます。 latex_elements などで参照していて、Sphinxが自動ではコピーしないファイルのコピーに使うと便利です。なお、ソースファイルの中で .. image:: を使って参照しているイメージファイルは、自動的にコピーされます。
ファイルの自動コピー時に、ファイル名が衝突しないように設定する必要があります。
New in version 0.6.
前書き(preamble)のLaTeXのマークアップを追加します。
Deprecated since version 0.5: latex_elements の 'papersize' を使用して下さい。
出力する用紙サイズのオプションです。 'a4paper' か 'letterpaper' が指定できます。デフォルトは 'letterpaper' です。
Deprecated since version 0.5: latex_elements の 'papersize' を使用して下さい。
フォントサイズです。 '10pt' か '11pt', '12pt' が指定できます。デフォルトは '10pt' です。
Deprecated since version 0.5: latex_elements の 'pointsize' を使用して下さい。
これらのオプションは、manページ出力に影響を与えます。
このオプションでは、ドキュメントツリーをどのようにグループ化してmanページに入れるか、というのを指定します。この設定は、 (startdocname, name, description, authors, section) というタプルのリストでなければなりません。それぞれの項目は次のような意味を持ちます。
New in version 1.0.
脚注
| [1] | 使用できるglob文法: 通常のシェルで使用する *, ?, [...], [!...] は使用できます。これらはすべてスラッシュにはマッチしません。 ** を使うと、スラッシュを 含む あらゆる文字列にマッチします。 |