配置¶

♪the configuration directory 名前のファイルを含まなければならない conf.py それがそうです。このファイル(Pythonコードを含む)は“構成ファイルを構築する”と呼ばれ、Sphinxの入出力アクションをカスタマイズするために必要なすべての構成が含まれています。

オプションの書類 docutils.conf 構成ディレクトリに追加して調整することができます Docutils 構成(Sphinxによって上書きまたは設定されていない場合)。

プロファイルは、構築時にPythonコードとして実行されます(使用 execfile() また，現在のディレクトリをディレクトリを含むように設定する)ため，任意の複雑なコードを実行することができる.そして，Sphinxはファイルの名前空間から簡単な名前をその構成として読み出す.

注意すべき重要事項：

別途記録されていない場合は，値は文字列でなければならず，そのデフォルト値は空文字列である.
用語“完全限定名”は、命名モジュール内で導入可能なPythonオブジェクトの文字列を意味し、例えば、FQN "sphinx.builders.Builder" つまり Builder 中の類 sphinx.builders モジュールです。
覚えておいてください、文書名は使用します / パスデリミタとしてファイル拡張子は含まれていない.
自.自.以来. conf.py Pythonファイル読み込みとして、通常のルールはコードとUnicodeサポートに適用されます。
名前空間を配置する内容はPickleedである(これでSphinxはいつ構成変更が変更されたかを知ることができる)ため，選択不可能な値は含まれていない可能性がある--以下の命令で名前空間からそれらを削除する. del もし合えば。モジュールは自動的に削除されますので、必要ありません del ご使用後の輸入品です。
特別な相手がいます tags プロファイルで利用可能です。タグの問い合わせや変更に利用できます(ご覧くださいタグに基づく内容も含まれています）。使用 tags.has('tag') 照会するには、以下の操作を実行してください。 tags.add('tag') そして tags.remove('tag') 変えることができますただ通過する -t コマンドラインオプションまたはVIA tags.add('tag') 以下のコマンドで問合せを行うことができます tags.has('tag') それがそうです。現在のビルダマークは使用できません conf.py 作成時に作成されたからです その後 ビルダは初期化される.

プロジェクト情報¶

project¶: 記録された項目の名前。

author¶: 文書の著者名。デフォルト値は 'unknown' それがそうです。

copyright¶

project_copyright¶: デザインの著作権表示 '2008, Author Name' それがそうです。

バージョン 3.5 で変更: 仮名としては project_copyright 許可されています

version¶: 主なプロジェクトバージョンは |version| それがそうです。例えばPython文書ではこれは 2.6 それがそうです。

release¶

完全なプロジェクトバージョンとして使われています |release| また，たとえばHTMLテンプレートでは.例えばPython文書ではこれは 2.6.0rc1 それがそうです。

もしあなたが必要でなければ version そして release これらを同じ値に設定すればよい.

通常の構成¶

extensions¶

のモジュール名の文字列リスト extensions それがそうです。これらはSphinxに付随する拡張モジュールであってもよい(名前は sphinx.ext.* )またはカスタマイズされています。

拡張できますのでご注意ください sys.path 拡張が別のディレクトリにある場合は、confファイルで使用してください--ただし、絶対パスを使用することを確認してください。もし拡張パスが configuration directory 使用 os.path.abspath() このように：

import sys, os

sys.path.append(os.path.abspath('sphinxext'))

extensions = ['extname']

これにより名前をロードすることができます extname サブディレクトリから sphinxext それがそうです。

プロファイル自体は拡張子であってもよい；そのためには、提供するだけでよい setup() その中で機能する。

source_suffix¶

ソースファイルのファイル拡張子。Sphinxは、その後のプレフィックスを有するファイルをソースとみなす。この値は、ファイル拡張子をファイルタイプにマッピングする辞書であってもよい。例えば：

source_suffix = {
    '.rst': 'restructuredtext',
    '.txt': 'restructuredtext',
    '.md': 'markdown',
}

デフォルトでは、Sphinxはサポートのみ 'restructuredtext' ファイルタイプです。ソースパーサ拡張子を使用して新しいファイルタイプを追加することができます。拡張された文書を読んで、拡張がどのファイルタイプをサポートしているかを理解してください。

この値はファイル拡張子リストであってもよい：Sphinxはそれらがすべてマッピングされていると考える 'restructuredtext' ファイルタイプです。

デフォルト値は {{'.rst': 'restructuredtext'}} それがそうです。

注釈

ファイル拡張子は、点で始まる必要がある(例えば、 .rst ）。

バージョン 1.3 で変更: 現在は拡張名リストとすることができます。

バージョン 1.8 で変更: ファイルタイプマッピングのサポート

source_encoding¶: すべてのRESTソースファイルの符号化。推奨されるコードとデフォルト値は 'utf-8-sig' それがそうです。

バージョン 0.5 で追加: 従来，SphinxはUTF-8コードソースのみを受け取っていた.

source_parsers¶

与えられれば，異なるソースコードに対する解析器クラス辞書で十分である.キーは接尾辞であり，値はクラスであってもよいし，解析器クラスの完全限定名を与える文字列であってもよい.解析器類は docutils.parsers.Parser あるいは…。 sphinx.parsers.Parser それがそうです。接尾辞が辞書にないファイルはデフォルトのreStruredText解析器を用いて解析する.

例えば：

source_parsers = {'.md': 'recommonmark.parser.CommonMarkParser'}

注釈

参考にする減記する. SphinxでMarkdownを用いたより多くの情報について.

バージョン 1.3 で追加.

バージョン 1.8 で非推奨: SphinxはAPIを提供しています Sphinx.add_source_parser() ソース解析器を登録するには，以下の操作を実行してください.代わりにこれを使ってください。

master_doc¶: “主”文書の文書名，すなわち根を含む文書 toctree 指令する。デフォルト値は 'index' それがそうです。

バージョン 2.0 で変更: デフォルト値を変更する 'index' 送信者. 'contents' それがそうです。

exclude_patterns¶

ソースファイルを検索する際に除外すべきグローバル·スタイル·モードのリスト。 1 これらは，ソースディレクトリに対するソースファイル名と一致し，すべてのプラットフォームでディレクトリデリミタとしてスラッシュを使用する.

例示的なパターン：

'library/xml.rst' --無視する library/xml.rst ファイル(置換中のエントリ unused_docs ）
'library/xml' --無視する library/xml カタログ.
'library/xml*' -- ignores all files and directories starting with library/xml
'**/.svn' --すべてを無視して .svn カタログ.

exclude_patterns 静的ファイルを検索する際にも参考になります html_static_path そして html_extra_path それがそうです。

バージョン 1.0 で追加.

templates_path¶: 追加テンプレート(または内蔵/トピック固有テンプレートをカバーするテンプレート)を含むルーティングテーブル。相対パスは構成ディレクトリに対してとみなされる.

バージョン 1.3 で変更: これらのファイルは構築するためのものではないため，自動的に追加される. exclude_patterns それがそうです。

template_bridge¶: 呼び出し可能(または単にクラス)を持つ完全に限定された名前の文字列を持ち，その文字列は返される TemplateBridge それがそうです。次いで、この例は、HTML文書を提示するために使用され、他のビルダ(現在はChangeビルダ)の出力を提示することができる。(HTMLトピックを用いるには，テンプレートブリッジがトピックを認識できる必要があることに注意されたい).

rst_epilog¶

読み出された各ソースファイルの末尾に含まれるreStrutiredText文字列。これは、各ファイルで利用可能であるべき置換を追加するための可能な位置である(もう1つは rst_prolog ）。例：：

rst_epilog = """
.. |psf| replace:: Python Software Foundation
"""

バージョン 0.6 で追加.

rst_prolog¶

読み出された各ソースファイルの先頭に含まれるreStrutiredText文字列を作成する。これは、各ファイルで利用可能であるべき置換を追加するための可能な位置である(もう1つは rst_epilog ）。例：：

rst_prolog = """
.. |psf| replace:: Python Software Foundation
"""

バージョン 1.0 で追加.

primary_domain¶: デフォルトの名称 domain それがそうです。そうでもいい None デフォルトドメインの使用を禁止するには，以下の操作を実行してください.黙認する. 'py' それがそうです。他のドメイン内のオブジェクト(ドメイン名が明示的に指定されていても、または default-domain 命令)は、名前が付けられたときにドメイン名を明示的に追加する(例えば、デフォルトドメインがCである場合、Python関数は“Function”だけではなく“Python Function”と命名される)。

バージョン 1.0 で追加.

default_role¶

デフォルト·ロールとして使用されるRESTロール(内蔵またはSphinx拡張子)の名前、すなわちタグ付けのためのテキスト `like this .これは `'py:obj'`` 使 `filter Python関数“filter”への交差参照。黙認する. ``None` デフォルトの役割を再割り当てしません。

デフォルトのロールは、常に標準RESTを使用して各文書に設定することができます default-role 指令する。

バージョン 0.4 で追加.

keep_warnings¶

真であれば，構築した文書では警告を“システムメッセージ”段落として保持する.この設定にかかわらず、以下の場合、警告は常に標準エラーストリームに書き込まれる。 sphinx-build 走ることです。

黙認する. False 0.5までの行動は，それらをつねに保持することである.

バージョン 0.5 で追加.

suppress_warnings¶

任意の警告メッセージの表示を禁止する警告タイプリスト。

Sphinxは、以下の警告タイプをサポートします。

app.add_node
app.add_directive
app.add_role
app.add_generic_role
app.add_source_parser
download.not_readable
image.not_readable
ref.term
ref.ref
ref.numref
ref.keyword
ref.option
ref.citation
ref.footnote
ref.doc
ref.python
misc.highlighting_failure
toc.circular
toc.secnum
epub.unknown_project_files
epub.duplicated_toc_entry
autosectionlabel.*

これらのタイプから選択できます。

さてこの選択肢を考えるべきです 試験的に それがそうです。

バージョン 1.4 で追加.

バージョン 1.5 で変更: 増列する. misc.highlighting_failure

バージョン 1.5.1 で変更: 増列する. epub.unknown_project_files

バージョン 1.6 で変更: 増列する. ref.footnote

バージョン 2.1 で変更: 増列する. autosectionlabel.*

バージョン 3.3.0 で変更: 増列する. epub.duplicated_toc_entry

needs_sphinx¶: もし設定が major.minor バージョン文字列、例えば '1.1' また，ライオンの顔画像はそのバージョンと比較し，古すぎる場合は構築を拒否する.デフォルト設定は無要求です。

バージョン 1.0 で追加.

バージョン 1.4 で変更: マイクロバージョンの文字列も受け付けています

needs_extensions¶

この値は、中の拡張モジュールのためのバージョン要求を指定する辞書であってもよい extensions 例えば、： needs_extensions = {{'sphinxcontrib.something': '1.5'}} それがそうです。バージョン文字列のフォーマットは major.minor それがそうです。すべての拡張に要求を指定する必要はなく，検査する拡張に要求を指定するだけでよい.

これは、拡張モジュールがSphinxとしてバージョンを指定することを要求します(参照 Sphinxの開発拡張どうやってそれをするか)。

バージョン 1.3 で追加.

manpages_url¶

交差引用するURL manpage 指令する。これを定義すると https://manpages.debian.org/{{path}} vt.的 :manpage: Man(1)`ロールは<https：//manpages.debian.org/man(1)>にリンクされる.利用可能なパターンには：

page -マニュアルページ (man ）

section -マニュアル部分 (1 ）

path -指定されたオリジナルマニュアルページとセクション (man(1) ）

これも指定されています man.1 それがそうです。

注釈

これは現在HTML作成者のみに影響を与えているが，将来的には拡大する可能性がある.

バージョン 1.7 で追加.

nitpicky¶: もし本当なら、ライオンの顔写真は警告します all 目標の引用が見つからない。デフォルト値は False それがそうです。以下のコマンドでこのモードを一時的にアクティブにすることができます -n コマンドラインスイッチ。

バージョン 1.0 で追加.

nitpick_ignore¶: 1部の明細書. (type, target) “難癖モード”で警告を生成する際に無視すべきタプル(デフォルトは空)である。ご注意ください type ドメイン名(存在する場合)を含むべきである.例示的な項目は以下のとおりである ('py:func', 'int') あるいは…。 ('envvar', 'LD_LIBRARY_PATH') それがそうです。

バージョン 1.1 で追加.

numfig¶: Trueであれば，図形，テーブル，コードブロックにタイトルがあれば，自動的にそれらを番号付けする.♪the numref キャラクターが起用されました。これまでHTMLとLaTeX構築者のみが遵守してきた.デフォルト値は False それがそうです。

注釈

LaTeX生成器は、このオプションを有効にするか否かにかかわらず、常に番号を割り当てる。

バージョン 1.3 で追加.

numfig_format¶

A dictionary mapping 'figure', 'table', 'code-block' and 'section' to strings that are used for format of figure numbers. As a special character, %s will be replaced to figure number.

Default is to use 'Fig. %s' for 'figure', 'Table %s' for 'table', 'Listing %s' for 'code-block' and 'Section' for 'section'.

バージョン 1.3 で追加.

numfig_secnum_depth¶

もし設定が 0 図形、表、コードブロックは最初から連続して番号付けされています。 1 それがそうです。
もし 1 (default) numbers will be x.1, x.2, ... with x the section number (top level sectioning; no x. 節がなければ).これは，以下のように節番号が活性化された場合にのみ適用される. :numbered: の選択肢です。 toctree 指令する。
2 means that numbers will be x.y.1, x.y.2, ... if located in a sub-section (but still x.1, x.2, ... if located directly under a section and 1, 2, ... if not in any top level section.)
ちょっと待って。

バージョン 1.3 で追加.

バージョン 1.7 で変更: LaTeXビルダはこの設定に従っています(もし numfig とする. True ）。

smartquotes¶

もし本当なら `Docutils Smart Quotes transform`_ _、最初にベース `SmartyPants`_ _(英語のみ)、現在は複数の言語に適用されており、引用符と破折番号をレイアウトが正しいエンティティに変換するために使用されています。デフォルト： True それがそうです。

バージョン 1.6.6 で追加: 時代遅れのものに取って代わっています html_use_smartypants それがそうです。デフォルトでは全ての構築器に適用されます man そして text (会いましょう) smartquotes_excludes ()

A docutils.conf _構成ディレクトリにあるファイル(またはグローバル ~/.docutils 文書)は以下の場合無条件に遵守する 使用を中止する. スマート見積もりはそれに応じた `Docutils option`_ _。しかしもしそれが 活性化する それが彼らだ smartquotes きっと勝つよ。

smartquotes_action¶: This string, for use with Docutils 0.14 or later, customizes the Smart Quotes transform. See the file smartquotes.py at the `Docutils repository`__ for details. The default 'qDe' educates normal quote characters ", ', em- and en-Dashes ---, --, and ellipses ....

バージョン 1.6.6 で追加.

smartquotes_excludes¶

これは dict デフォルト値は：

{'languages': ['ja'], 'builders': ['man', 'text']}

全ての項目は無視を与えています smartquotes スマート見積変換を設定して無効にします。受け取った鍵は以上のとおりである. 'builders' あるいは…。 'languages' それがそうです。値はリストです。

注釈

現在呼び出している場合 make 複数のターゲットについて、第1のターゲット名は一意である 'builders' それはすべての人のために決定を下すだろう。もう一つは make text 従う make html 以下の表で発行する必要があります。 make text O="-E" キャッシュされたファイルが変換されているため、ソースファイルを強制的に再解析します。一方，直接使用する sphinx-build これは、各ビルダ位置キャッシュ(デフォルト使用)で解析されたソースファイルであるからである。

ヒント

所与のビルダのスマートオファーを効率的に無効にする(またはカスタマイズする)別の方法、例えば、 latex 使用することです make こちらへ。

make latex O="-D smartquotes_action="

これは何かに従うことができます make html 問題ありません。前のメモの状況とは対照的です。それはDocutils 0.14以上のバージョンが必要だ。

バージョン 1.6.6 で追加.

user_agent¶: スフィンクスのユーザーエージェント。これは、HTTPアクセス上のヘッダ(例えば、Linkcheck，intersphinxなど).デフォルト値は "Sphinx/X.Y.Z requests/X.Y.Z python/X.Y.Z" それがそうです。

バージョン 2.3 で追加.

tls_verify¶: もし真であれば，Sphinxはサーバ証明書を検証する.デフォルト値は True それがそうです。

バージョン 1.5 で追加.

tls_cacerts¶: CAの証明書ファイルのパスや証明書のディレクトリを含むパス.これにより，辞書がホスト名を証明書ファイルにマッピングする経路も可能になる.証明書はサーバ証明書の検証に用いられる.

バージョン 1.5 で追加.

ちなみに

ライオンの顔像を使っています requests 内部のHTTPライブラリとする.したがって，Sphinxは指すディレクトリ上の認証ファイルを参照する. REQUESTS_CA_BUNDLE 環境変数IF tls_cacerts 設定されていません。

today¶

today_fmt¶

これらの値は、現在の日付をどのように設定するかを決定し、その日付が使用される |today| それがそうです。

もしあなたが設定したら today 非空値に設定すると，これを使用する.
そうでなければ、現在の時間は使用されます time.strftime() 和中に与えられた書式 today_fmt それがそうです。

デフォルト値は現在 today 1つと today_fmt の '%B %d, %Y' (または、変換が有効にされている場合 language 選択された領域に設定された等価フォーマット)。

highlight_language¶: ソースコードを強調表示するためのデフォルト言語.黙認する. 'python3' それがそうです。この値は有効なPygments形態素解析器名であるべきであるので，参照されたい表示コード例もっと細かいことを知っています。

バージョン 0.5 で追加.

バージョン 1.4 で変更: デフォルト値は現在 'default' それがそうです。これは似たようなものです 'python3' これは主に 'python' しかしそれは 'none' 失敗すれば何の警告も出さない。 'python3' もし失敗したら、他の言語は警告を発するだろう。Python 2のみをハイライトすることが好きな場合は、再設定することができます 'python' それがそうです。

highlight_options¶

言語名をPygmentsの字句解析器モジュールオプションの辞書にマッピングする.これらのオプションはlexer固有である；各オプションの理解については、参照されたい Pygments documentation それがそうです。

例：：

highlight_options = {
  'default': {'stripall': True},
  'php': {'startinline': True},
}

単一のオプション辞書の使用も許可されている。そして，指定された形態素解析器のオプションとして認識される highlight_language **

# configuration for the ``highlight_language``
highlight_options = {'stripall': True}

バージョン 1.3 で追加.

バージョン 3.5 で変更: 複数言語の強調表示オプションの構成を可能にする

pygments_style¶: Pygmentsでは、ソースコードのスタイル名を強調表示します。設定されていない場合、トピックのデフォルトスタイルまたは 'sphinx' HTML出力用を選択する.

バージョン 0.3 で変更: この値がカスタムPygmentsスタイルクラスの完全限定名であれば，カスタムスタイルとして用いる.

add_function_parentheses¶: 関数およびメソッドロールテキストのブール値に丸括弧を付加するかどうか(例えば、 :func:`input )この名前が呼び出し可能であることを表す.デフォルト値は ``True` それがそうです。

add_module_names¶: モジュール名をすべての名前の前に置くかどうかを決定するブール値です object 名前(ある“モジュール”が定義されたオブジェクトタイプに対して)、例えば py:function 指令する。デフォルト値は True それがそうです。

show_authors¶: ブル値であるかどうかを決定します codeauthor そして sectionauthor コマンドは，構築されたファイルに任意の出力を生成する.

modindex_common_prefix¶: Pythonモジュールインデックスをソートする際に無視されるプレフィックスリスト(例えば、設定されている場合 ['foo.'] そして、そして foo.bar 下に表示する B やめて！ F ）。もしあなたが単一のパッケージで構成された項目を記録すれば、これは便利だ。現在はHTMLビルダにのみ適用されている.デフォルト値は [] それがそうです。

バージョン 0.6 で追加.

trim_footnote_reference_space¶: 脚注引用前のスペースを剪定し，これらのスペースはREST解析器が脚注を認識するために必要であるが，出力にはあまり良くないように見える。

バージョン 0.6 で追加.

trim_doctest_flags¶: もし本当ならdoctestフラグ(注釈が似ているように見える) # doctest: FLAG, ... )と <BLANKLINE> 対話型Pythonセッション(すなわちdoctest)を表示するすべてのコードブロックのフラグが除去されます。デフォルト値は True それがそうです。拡張子を参照してください doctest より多くの文書テストを含む可能性を得るために。

バージョン 1.0 で追加.

バージョン 1.1 で変更: 今も削除しました <BLANKLINE> それがそうです。

strip_signature_backslash¶: デフォルト値は False それがそうです。逆スラッシュを有効にして剥離すると、毎回現れます \\ ドメインでは、命令はさらに変更されます \ 文字列文字においても同様である.これはバージョン3.0までのアクションであり，この変数を True このような行動を回復します

バージョン 3.0 で追加.

国際化オプション¶

これらの選択肢はスフィンクスに影響を与えるだろう 地元言語サポート それがそうです。上の文書を参照してください国際化する. もっと細かいことを知っています。

language¶

文書用言語のコード。Sphinxが自動生成したどのテキストもこの言語を用いる.また，Sphinxは，文書中の個々のパラグラフを以下の位置から得られた翻訳セットを用いて置き換えることを試みる locale_dirs それがそうです。ライオンの顔像は特定の言語の数字を検索して名付けました figure_language_filename (例えばドイツ語版の myfigure.png はい。はい。 myfigure.de.png デフォルト設定)を用いて、元の図形を置換します。LaTeXビルダでは，適切な言語を選択する. バーベル塔 小包です。デフォルト値は None これは，何の翻訳も行われないことを意味する.

バージョン 0.5 で追加.

バージョン 1.4 で変更: 図形置換をサポートする

Sphinxが現在サポートしている言語は：

ar アラビア語で
bg ブルガリア人
bn --バングラデシュ語
ca カタロニア語
cak --カーチケル
cs --チェコ
cy ウェールズ語
da --デンマーク
de --ドイツ語
el --ギリシャ語
en --英語
eo --エスペラント語
es --スペイン語
et エストニア語
eu -バスク
fa --イラン
fi --フィンランド語
fr --フランス語
he ヘブライ語です
hi --ヒンディー語
hi_IN --ヒンディー語(インド)
hr クロアチア人
hu --ハンガリー語
id --インドネシア。
it --イタリア語
ja --日本語
ko --韓国語
lt リトアニア人は
lv -ラトビア
mk --マケドニア語
nb_NO ノルウェーのボックマールは
ne --ネパール語
nl オランダ語です
pl --ポーランド語
pt --ポルトガル語
pt_BR ブラジルのポルトガル語
pt_PT --ヨーロッパポルトガル語
ro ルーマニア人.
ru --ロシア語
si --サンガロー語
sk スロバキア
sl スロベニア
sq --アルバニア語
sr --セルビア語
sr@latin --セルビア語(ラテン語)
sr_RS --セルビア語(シリルビン)
sv --スウェーデン語
ta --タミル語
te --タイル固語
tr --トルコ語
uk_UA ウクライナ人は
ur ウルドゥー語です
vi --ベトナム語
zh_CN --簡体字中国語
zh_TW --繁体中国語

locale_dirs¶

バージョン 0.5 で追加.

その中で他のメーリングリストのディレクトリを検索します(参照) language )に対して、ソースディレクトリ。この経路上のディレクトリは標準的に検索する gettext モジュールです。

内部メッセージは，テキストドメインから抽出される. sphinx ；したがって，ディレクトリを追加すると ./locale この設定により，メッセージディレクトリ(から) .po 書式使用 msgfmt )にいなければならない ./locale/{language}/LC_MESSAGES/sphinx.mo それがそうです。個々の文書のテキストドメインは gettext_compact それがそうです。

黙認する. ['locales'] それがそうです。

バージョン 1.5 で変更: 使用 locales ディレクトリをデフォルト値とする

gettext_compact¶

バージョン 1.1 で追加.

Trueであれば，文書のテキストドメイン(文書がトッププロジェクトファイルであれば)がその文書名であり，そうでなければその最も基本的なディレクトリである.

文字列に設定すると，すべての文書のテキストドメインがその文字列となり，すべての文書が単一のテキストドメインを使用するようになる.

デフォルトの場合、文書 markup/code.rst 最終的に送り込まれました markup テキストドメインです。このオプションを設定します False これは markup/code それがそうです。

バージョン 3.3 で変更: 文字列の値を受け取ります。

gettext_uuid¶

Trueである場合、Sphinxは、メッセージディレクトリ内のバージョン追跡のためのUUID情報を生成する。これは次のようなものです

.potファイルの各msgidにuid行を追加します。
新しいメッセージIDと以前に保存されていた古いメッセージIDとの類似度を計算する.この計算には長い時間がかかる。

計算を加速させたい場合は、ご利用いただけます python-levenshtein C言語で書かれた第三者バッグ pip install python-levenshtein それがそうです。

黙認する. False それがそうです。

バージョン 1.3 で追加.

gettext_location¶

Trueであれば，Sphinxはメッセージディレクトリ中のメッセージのための位置情報を生成する.

黙認する. True それがそうです。

バージョン 1.3 で追加.

gettext_auto_build¶

Trueの場合、Sphinxは翻訳ディレクトリファイルごとにmoファイルを構築します。

黙認する. True それがそうです。

バージョン 1.3 で追加.

gettext_additional_targets¶

I 18 Nに追加のgettext抽出および翻訳を可能にするために名前を指定します。以下の名前を指定することができます。

指標.: 索引項.
文字ブロック.: 文字ブロック. (:: 注釈と code-block 指令)
文書テストブロック: 文書テストブロック
未加工の: 原始含有量
影像.: 画像/グラフィックスURIとALT

例： gettext_additional_targets = ['literal-block', 'image'] それがそうです。

黙認する. [] それがそうです。

バージョン 1.3 で追加.

figure_language_filename¶

特定言語パターンのファイル名フォーマット。デフォルト値は {{root}}.{{language}}{{ext}} それがそうです。これは拡張されます dirname/filename.en.png 送信者. .. image:: dirname/filename.png それがそうです。利用可能なフォーマットトークンは、：

{root} - the filename, including any path component, without the file extension, e.g. dirname/filename
{path} - the directory path component of the filename, with a trailing slash if non-empty, e.g. dirname/
{{docpath}} 現在の文書のディレクトリパスコンポーネントであって、空でない場合、後部スラッシュを使用するディレクトリパスコンポーネント。
{basename} - the filename without the directory path or file extension components, e.g. filename
{ext} - the file extension, e.g. .png
{language} - the translation language, e.g. en

例えば、これを {{path}}{{language}}/{{basename}}{{ext}} 拡張していくことになります dirname/en/filename.png 代わりに。

バージョン 1.4 で追加.

バージョン 1.5 で変更: 増列する. {{path}} そして {{basename}} トークンです。

バージョン 3.2 で変更: 増列する. {{docpath}} トークンです。

数学的選択肢¶

これらのオプションは数学的記号に影響を与える。

math_number_all¶: このオプションを設定します True 表示されているすべての数学を番号付けする場合は、以下の操作を実行してください。黙認する. False それがそうです。

math_eqref_format¶

式参照タグの文字列をフォーマットするために用いられる.♪the {{number}} 占位子は方程式番号を表す.

例： 'Eq.{{number}}' 例えば Eq.10 それがそうです。

math_numfig¶: もし True ただし，表示される数学方程式は以下の場合ページ番号をまたぐ. numfig 有効になりました。♪the numfig_secnum_depth 環境は尊重されている。♪the eq やめて！ numref ロールは，引用式番号に用いられなければならない.デフォルト値は True それがそうです。

バージョン 1.7 で追加.

HTML出力用オプション¶

これらのオプションは，HTMLやHTMLヘルプ出力や，他のSphinxを用いたHTMLWriterクラスの構築器に影響を与える.

html_theme¶: HTMLは使用すべき“テーマ”を出力する.ご参照ください section about theming それがそうです。黙認する. 'alabaster' それがそうです。

バージョン 0.6 で追加.

html_theme_options¶: 選択されたトピックの外観に影響を与えるオプション辞書。これらは特定のテーマです。内蔵テーマ理解に関するオプションは、ご参照ください this section それがそうです。

バージョン 0.6 で追加.

html_theme_path¶: カスタムトピックを含むルーティングテーブルは、サブディレクトリであってもよいし、zipファイルであってもよい。相対パスは構成ディレクトリに対してとみなされる.

バージョン 0.6 で追加.

html_style¶: HTMLページのスタイル表に用いられる.この名前のファイルはSphinxに存在しなければならない static/ パス、または中で与えられたカスタムパスのうちの1つ html_static_path それがそうです。デフォルト値は、選択されたトピックによって提供されるサンプルテーブルです。テーマスタイル表と比較して、いくつかのコンテンツを追加または上書きしたい場合は、CSSをご利用ください @import トピックのスタイル表を導入する場合は、以下の操作を実行してください。

html_title¶: Sphinx自身のテンプレートを用いて生成されたHTML文書の“タイトル”である.これは追加されました <title> タグは，ナビゲーション欄に“最上位”要素として使用する.デフォルト値は '{<project>} v{<revision>} documentation' それがそうです。

html_short_title¶: HTML文書の短い“タイトル”ですこれは，タイトルとHTMLヘルプ文書中のリンクに用いられる.指定されていなければ，デフォルトで考える. html_title それがそうです。

バージョン 0.4 で追加.

html_baseurl¶: HTML文書のルートを指す基URL.文書の位置や使用を示すために使われています The Canonical Link Relation それがそうです。デフォルト： '' それがそうです。

バージョン 1.8 で追加.

html_codeblock_linenos_style¶

コードブロックの行番号パターン。

'table' --表示行番号を使用して <table> ラベル(デフォルト)
'inline' --表示行番号を使用して <span> 標札.

バージョン 3.2 で追加.

html_context¶: すべてのページのテンプレートエンジンコンテキストに渡される値辞書.属性はこの辞書に個々の値を入れることも可能である. -A コマンドラインオプション sphinx-build それがそうです。

バージョン 0.5 で追加.

html_logo¶: 与えられた場合、これは画像ファイルの名前でなければならない(相対的に configuration directory )それはファイルのロゴです。サイドバーの上部に配置されている；したがって、その幅は200画素を超えてはならない。デフォルト： None それがそうです。

バージョン 0.4.1 で追加: この画像ファイルは _static HTMLのディレクトリを出力するが，そのファイルがまだ存在しない場合にのみ.

html_favicon¶: 与えられた場合、これは画像ファイルの名前でなければならない(相対的に configuration directory )それは文書のお気に入りのアイコンです。現代のブラウザでは、オプションカード、ウィンドウ、およびブックマークのアイコンとして使用されています。Windowsスタイルのアイコンファイルのはずです (.ico )であり、サイズは16 x 16または32 x 32画素である。デフォルト： None それがそうです。

バージョン 0.4 で追加: この画像ファイルは _static HTMLのディレクトリを出力するが，そのファイルがまだ存在しない場合にのみ.

html_css_files¶

CSSファイルリスト。項目はそうでなければならない ファイル名 文字列または含まれている ファイル名 文字列と属性辞書です。♪the ファイル名 比較しなければなりません html_static_path または、以下のスキームを有する完全なURI http://example.org/style.css それがそうです。♪the 属性使用する <link> ラベル。デフォルトは空リストです。

例：：

html_css_files = ['custom.css',
                  'https://example.com/css/custom.css',
                  ('print.css', {'media': 'print'})]

特殊な属性として 優先度. 事前または遅延ステップでCSSファイルをロードするために整数に設定することができる。詳細についてはご参照ください Sphinx.add_css_files() それがそうです。

バージョン 1.8 で追加.

バージョン 3.5 で変更: 優先度属性のサポート

html_js_files¶

JavaScriptリスト ファイル名 それがそうです。項目はそうでなければならない ファイル名 文字列または含まれている ファイル名 文字列と属性辞書です。♪the ファイル名 比較しなければなりません html_static_path または、以下のスキームを有する完全なURI http://example.org/script.js それがそうです。♪the 属性使用する <script> ラベル。デフォルトは空リストです。

例：：

html_js_files = ['script.js',
                 'https://example.com/scripts/custom.js',
                 ('custom.js', {'async': 'async'})]

特殊な属性として 優先度. 事前または遅延ステップでCSSファイルをロードするために整数に設定することができる。詳細についてはご参照ください Sphinx.add_css_files() それがそうです。

バージョン 1.8 で追加.

バージョン 3.5 で変更: 優先度属性のサポート

html_static_path¶

カスタム静的ファイル(サンプルテーブルまたはスクリプトファイルのような)を含むルーティングテーブル。相対パスは構成ディレクトリに対してとみなされる.出力にコピーされています _static トピックの静的ファイルの後のディレクトリには，そのため1つの名前がある. default.css テーマをカバーするのは default.css それがそうです。

これらのファイルは構築するために使用されていないので、ソースファイルから自動的に除外される。

注釈

セキュリティ上、以下のディレクトリ下のdotfile html_static_path コピーされません。意図的にコピーしたい場合は、各ファイルパスをこの設定に追加してください。

html_static_path = ['_static', '_static/.htaccess']

もう一つの方法は、あなたはまた使用することができます html_extra_path それがそうです。これは、ディレクトリの下のポイントファイルをコピーすることを可能にします。

バージョン 0.4 で変更: 中の経路 html_static_path 今はサブディレクトリを含めることができます。

バージョン 1.0 で変更: 中の項目 html_static_path 今は単一のファイルであってもよい。

バージョン 1.8 で変更: 下の書類 html_static_path ソースファイルから除外します。

html_extra_path¶

文書と直接関係のない追加ファイルを含むルーティングテーブル、例えば robots.txt あるいは…。 .htaccess それがそうです。相対パスは構成ディレクトリに対してとみなされる.これらは出力ディレクトリにコピーされる.それらは既存の任意の同名ファイルをカバーするだろう。

これらのファイルは構築するために使用されていないので、ソースファイルから自動的に除外される。

バージョン 1.2 で追加.

バージョン 1.4 で変更: 追加ディレクトリのポイントファイルは、出力ディレクトリにコピーされます。これはつまり exclude_patterns 追加のファイルおよびディレクトリをコピーし、パスがパターンに一致するかどうかを無視します。

html_last_updated_fmt¶: NONEでなければ、各ページの下部に“前回更新時間：”タイムスタンプを挿入し、所与のものを使用する strftime() フォーマットです。空文字列は '%b %d, %Y' (または領域設定に関連する等価物)。

html_use_smartypants¶: Trueであれば，引用符と破折番号はレイアウトが正しいエンティティに変換される.デフォルト： True それがそうです。

バージョン 1.6 で非推奨: スマート引用符を無効にするには、ご利用ください smartquotes それがそうです。

html_add_permalinks¶

Sphinxは，タイトルや記述環境ごとに“永久リンク”を付加し，段落記号として，これらの環境上にマウスが懸架している場合には，これらの記号が見えるようになる.

この値は固定リンクのテキストを決定する；デフォルトでは "¶" それがそうです。とする. None 固定リンクを無効にするために空文字列を表示します。

バージョン 0.6 で追加: 従来，このオプションはつねにアクティブ状態であった.

バージョン 1.1 で変更: 現在，リンクの実際のテキストを選択するための文字列であってもよい.従来，ブール値のみを受け取っていた.

html_sidebars¶

サイドバーテンプレートをカスタマイズするには，文書名をテンプレート名にマッピングする辞書でなければならない.

キーにはグローバル·スタイルのパターンが含まれていてもよい 1, この場合，すべての適合文書は指定されたサイドバーが得られる.(任意の文書に複数のグローバル·パターン·パターン·マッチングがある場合には、警告が発行されます。)

これらの値は、リストであってもよいし、単一の文字列であってもよい。

値がリストである場合、含めるべきサイドバーテンプレートの完全リストを指定する。デフォルトサイドバーのすべてまたは一部が含まれる場合、それらもこのリストに入れられなければならない。

デフォルト側のバー(どのパターンにも適合しないための文書)は、トピック自体によって定義される。デフォルトの場合、内蔵トピックは以下のテンプレートを使用します。 ['localtoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html'] それがそうです。
値が単一の文字列であれば、どこにあるかを指定する 'sourcelink.html' そして 'searchbox.html' 参加作品。これは，Sphinx 1.0以前のバージョンと互換性があるためである.

バージョン 1.7 で非推奨: 1文字列の値です html_sidebars 2.0で削除されます

レンダリング可能な内蔵サイドバーテンプレートは、：

localtoc.html --現在のドキュメントの細粒度ディレクトリ
globaltoc.html 文書集全体の粗粒度ディレクトリ、折り畳み
relations.html --前のファイルと次のファイルの2つのリンクを指します
sourcelink.html --現在のドキュメントソースへのリンク(有効化中であれば) html_show_sourcelink
searchbox.html --“高速検索”ボックス

例：：

html_sidebars = {
   '**': ['globaltoc.html', 'sourcelink.html', 'searchbox.html'],
   'using/windows': ['windowssidebar.html', 'searchbox.html'],
}

これはカスタムテンプレートを提示します windowssidebar.html 所与の文書のサイドバー内の高速検索ボックスと、他のすべてのページのデフォルトサイドバー(ローカルTOCがグローバルTOCに置き換えられていることを除いて)が提示される。

バージョン 1.0 で追加: グローバル鍵を使用して、複数のサイドバーを指定する能力。

この値は、選択されたトピックがサイドバー(例えば内蔵)を持たない場合にのみ有効であることに注意されたい 巻物. そして テコンドー テーマです。

html_additional_pages¶

HTMLページに提示すべき他のテンプレートは，文書名をテンプレート名にマッピングする辞書でなければならない.

例：：

html_additional_pages = {
    'download': 'customdownload.html',
}

これはテンプレートを提示します customdownload.html ページとして download.html それがそうです。

html_domain_indices¶

Trueであれば，通常のインデックスを生成するほか，ドメイン固有のインデックスを生成する.例えば、Pythonドメインの場合、これはグローバルモジュールインデックスです。デフォルト値は True それがそうです。

この値は、ブール値であってもよいし、生成すべきインデックス名リストであってもよい。特定のインデックスのインデックス名を検索するには、HTMLファイル名を確認してください。例えば、Pythonモジュールインデックスの名前は 'py-modindex' それがそうです。

バージョン 1.0 で追加.

html_use_index¶: Trueであれば，HTML文書にインデックスを付与する.デフォルト値は True それがそうです。

バージョン 0.4 で追加.

html_split_index¶: Trueであれば，インデックスは1回をすべてのエントリを含む単ページとし，もう1回を各先頭アルファベットの1ページとする2回生成する.デフォルト値は False それがそうです。

バージョン 0.4 で追加.

html_copy_source¶: Trueであれば，RESTソースコードはHTML構築に含まれ，フォーマットは _sources/{name} それがそうです。黙認する. True それがそうです。

html_show_sourcelink¶: 本当なら(と) html_copy_source 正しい)，RESTソースコードへのリンクはサイドバーに追加される.黙認する. True それがそうです。

バージョン 0.6 で追加.

html_sourcelink_suffix¶: ソースリンクに付加される接尾辞(参照) html_show_sourcelink )は、彼らがすでにこの接尾辞を持っていない限り。デフォルト値は '.txt' それがそうです。

バージョン 1.5 で追加.

html_use_opensearch¶: 空でなければ戻ります OpenSearch 記述ファイルが出力され、すべてのページに含まれます <link> タグを引用していますOpenSearchはその検索ページ位置の相対URLをサポートしていないため，このオプションの値は，これらの文書の基本URL(スラッシュに付随していない)を提供することでなければならない，たとえば. "https://docs.python.org" それがそうです。黙認する. '' それがそうです。

html_file_suffix¶: これは，生成されたHTML文書のファイル名接尾辞である.黙認する. ".html" それがそうです。

バージョン 0.4 で追加.

html_link_suffix¶: 生成されたHTML文書へのリンクの接尾辞.デフォルト値はAnywhere html_file_suffix 設定は、(例えば、異なるWebサーバ設定をサポートするために)異なる設定を行うことができる。

バージョン 0.6 で追加.

html_show_copyright¶: もし事実なら“(C)著作権...”HTMLページの足に表示されます。デフォルト値は True それがそうです。

バージョン 1.0 で追加.

html_show_sphinx¶: Trueであれば，“Created with Sphinx”がHTMLページの足に表示される.デフォルト値は True それがそうです。

バージョン 0.4 で追加.

html_output_encoding¶: HTMLはファイルのコードを出力する.デフォルト値は 'utf-8' それがそうです。このコード名は、有効なPythonコード名と有効なHTMLである必要があることに注意してください。 charset 値。

バージョン 1.0 で追加.

html_compact_lists¶: Trueである場合、リスト内のすべての項目は、単一の段落および/またはサブリストからなる。(再帰的定義)は使用されない <p> 元素のいずれかですこれは標準的なdocutils行動だ。デフォルト： True それがそうです。

バージョン 1.0 で追加.

html_secnumber_suffix¶: 節番号の接尾辞デフォルト： ". " それがそうです。とする. " " 節番号上の最後の点をキャンセルする場合は、以下の操作を実行してください。

バージョン 1.0 で追加.

html_search_language¶

HTML全文検索インデックスを生成するための言語.デフォルトは選択されたグローバル言語を使用するために language それがそうです。この言語がサポートされていなければ "en" 英語の言語を選ぶために使われています。

以下の言語の支援を提供する：

da --デンマーク
nl オランダ語です
en --英語
fi --フィンランド語
fr --フランス語
de --ドイツ語
hu --ハンガリー語
it --イタリア語
ja --日本語
no -ノルウェーだ
pt --ポルトガル語
ro ルーマニア人.
ru --ロシア語
es --スペイン語
sv --スウェーデン語
tr --トルコ語
zh --中国語

構築速度を速める

それぞれの言語(日本語を除く)は自分の語幹アルゴリズムを提供するデフォルトの場合、SphinxはPythonを使用して実現されます。C実装を使用してインデックスファイルの構築を加速することができます。

PorterStemmer (en ）
PyStemmer (すべての言語)

バージョン 1.1 で追加: 支持する. en そして ja それがそうです。

バージョン 1.3 で変更: 他の言語を追加しました。

html_search_options¶

検索言語サポートオプション付き辞書は，デフォルトでは空である.これらのオプションの意味は選択された言語に依存する。

英語のサポートには選択の余地がありません。

日本側の支持には次のような選択肢がある。

タイプ

type‘は、そこから派生すべき分割器実装を指定するための点分割モジュール経路文字列である :class:`sphinx.search.ja.BaseSplitter それがそうです。指定されていない場合または指定されていない場合， 'sphinx.search.ja.DefaultSplitter' 使用されます。

以下のモジュールから選択できます。

'sphinx.search.ja.DefaultSplitter': TinySegmenterアルゴリズムですこれはデフォルト分解器です。
'sphinx.search.ja.MecabSplitter': MeCabバインディング。このスプリッタを用いるためには，‘mecab’pythonバインディングや動的リンクライブラリ(Linuxは‘libmecab.so’，Windowsは‘libmecab.dll’)が必要である.
'sphinx.search.ja.JanomeSplitter': ジェニム装丁。この分離器を使うには Janome 必要です。

バージョン 1.6 で非推奨: 'mecab', 'janome' and 'default' is deprecated. To keep compatibility, 'mecab', 'janome' and 'default' are also acceptable.

他のオプション値は、選択された分解値に依存します。

オプション： 'mecab' ：

dic_enc: _`dic_enc option‘はMeCabアルゴリズムのコードである.
ディクト！: _``dict option`はMeCabアルゴリズムで使用される辞書である.
リブ.: _`lib option`は，Pythonバインディングがインストールされていない場合，ctypeでMeCabライブラリのライブラリ名を探す.

例えば：

html_search_options = {
    'type': 'mecab',
    'dic_enc': 'utf-8',
    'dict': '/path/to/mecab.dic',
    'lib': '/path/to/libmecab.so',
}

オプション： 'janome' ：

user_dic: _``user_dic option‘はJanomeのユーザ辞書ファイルパスである.
user_dic_enc: `user_dic_enc option‘は，指定されたユーザ辞書ファイルの符号化である. ``user_dic` 選択します。デフォルト値は‘UTF 8’である.

バージョン 1.1 で追加.

バージョン 1.4 で変更: 日本語を再編成したHTML_SEARCH_OPTIONSは、どのカスタム分解器も type 設置します。

中国の支援には以下のような選択肢がある。

dict - jieba カスタム辞書を用いるのであれば，辞書パスとする.

html_search_scorer¶: 検索結果スコアレータを実現するJavaScriptファイルの名前(配置ディレクトリに対する).空であれば、デフォルト値を使用します。

バージョン 1.2 で追加.

html_scaled_image_link¶

Trueである場合、画像自体が元の画像にリンクされる(“ターゲット”オプションまたはズームに関連するオプション：“Scale”、“Width”、“Height”)がない場合)。黙認する. True それがそうです。

文書作成者はこの機能を手動で提供することができる no-scaled-link クラスを画像に追加します：

.. image:: sphinx.png
   :scale: 50%
   :class: no-scaled-link

バージョン 1.3 で追加.

バージョン 3.0 で変更: 以下の特性を有する画像については、オプションは無効状態である no-scaled-link クラス

html_math_renderer¶: HTMLが出力するMATH_RENDER拡張子.黙認する. 'mathjax' それがそうです。

バージョン 1.8 で追加.

html_experimental_html5_writer¶: 出力はHTML 5コンパイラで処理する.この機能にはdocutils 0.13以上が必要です。デフォルト値は False それがそうです。

バージョン 1.6 で追加.

バージョン 2.0 で非推奨.

html4_writer¶: 出力はHTML 4コンパイラで処理する.デフォルト値は False それがそうです。

単一のHTML出力のためのオプション¶

singlehtml_sidebars¶: サイドバーテンプレートをカスタマイズするには，文書名をテンプレート名にマッピングする辞書でなければならない.そしてそれは名前だけを許可しています 'index' それがそうです。他のすべての重要な点は無視されるだろう。詳細についてはご参照ください html_sidebars それがそうです。デフォルトでは html_sidebars それがそうです。

HTMLヘルプを出力するためのオプション¶

htmlhelp_basename¶: HTMLヘルプ生成器の出力ファイルベース名.デフォルト値は 'pydoc' それがそうです。

htmlhelp_file_suffix¶: これは，生成されたHTMLヘルプファイルのファイル名接尾辞である.黙認する. ".html" それがそうです。

バージョン 2.0 で追加.

htmlhelp_link_suffix¶: 生成されたHTML文書へのリンクの接尾辞.黙認する. ".html" それがそうです。

バージョン 2.0 で追加.

Appleはオプションの出力を支援します¶

バージョン 1.3 で追加.

これらのオプションはAppleヘルプ出力に影響を与えます。このビルダはHTMLビルダから派生するため，HTMLオプションは適切な場所にも適用可能である.

注釈

Appleヘルプ出力はMacOSX 10.6以上でしか実行できません hiutil そして codesign 命令行ツールはオープンソースではありません

以下のコマンドでこれらのツールを無効にすることができます applehelp_disable_external_tools インデックスを実行するまでは，結果は有効なヘルプマニュアルとはならない. .lproj バッグの中のファイルを束ねる。

applehelp_bundle_name¶: Apple Help Bookの基本名です。デフォルト設定は project 名前。

applehelp_bundle_id¶: 本梱包梱包を助けるバンドルID。

警告

お前 must この値を設定してAppleヘルプを生成します。

applehelp_dev_region¶: 開発区です。黙認する. 'en-us' これはリンゴのおすすめの設定です。

applehelp_bundle_version¶: バンドルバージョン(文字列形式)。黙認する. '1' それがそうです。

applehelp_icon¶: ヘルプ·パケットアイコン·ファイル、または None アイコンがないからです。アップルの文書によると、これは16 x 16ピクセルバージョンのアプリケーションアイコンであり、背景は透明であり、PNGファイルとして保存されているはずである。

applehelp_kb_product¶: 使用製品ラベル applehelp_kb_url それがそうです。黙認する. '{<project>}-{<release>}' それがそうです。

applehelp_kb_url¶

The URL for your knowledgebase server, e.g. https://example.com/kbsearch.py?p='product'&q='query'&l='lang'. Help Viewer will replace the values 'product', 'query' and 'lang' at runtime with the contents of applehelp_kb_product, the text entered by the user in the search box and the user's system language respectively.

黙認する. None 遠隔検索は必要ありません。

applehelp_remote_url¶

遠隔コンテンツのURL。ヘルプブックのコピーを Resources フォルダ，ヘルプビューアは，そのフォルダを用いて更新されたコンテンツの取得を試みる.

例えばこれを https://example.com/help/Foo/ Helpビューアが必要だ index.html 英語が話せるお客様には、チェックします https://example.com/help/Foo/en.lproj/index.html それがそうです。

黙認する. None 遠隔コンテンツはありません。

applehelp_index_anchors¶: もし True ヘルプインデックスインデックスが生成したHTML中のアンカを教えてください。属性が特定のトピックにジャンプした場合，これは有用である. AHLookupAnchor 関数や openHelpAnchor:inBook: 方法です。またご利用いただけます help:anchor URL；このトピックについての詳細は、Appleドキュメントを参照してください。

applehelp_min_term_length¶: ヘルプインデックスの最小ターム長を制御する。黙認する. None これは、デフォルト値が使用されることを意味します。

applehelp_stopwords¶

言語仕様(内蔵のストップワードを使用する)、またはストップワードスペルリストのパス、または None もしあなたがストップワードを使いたくないなら。デフォルトの停止語plistは以下の位置で見つけることができる /usr/share/hiutil/Stopwords.plist 本稿を作成する際には，以下の言語の無効語を含む：

言語	コード
英語の授業	うんうん
ドイツ語.	デ
西洋語.	Es
フランス語	はい。
スウェーデン語.	SV
ハンガリー語.	胡祖六
イタリア語	それは

黙認する. language または、設定されていない場合には、 en それがそうです。

applehelp_locale¶

その生成支援のための領域設定を指定する.これは特定に使われています .lproj ヘルプマニュアルのフォルダ Resources ヘルプインデックスに渡されます

黙認する. language または、設定されていない場合には、 en それがそうです。

applehelp_title¶: ヘルプマニュアルのタイトルを指定します。黙認する. '{<project>} Help' それがそうです。

applehelp_codesign_identity¶

コード署名のための識別情報を指定するか、または None コード署名を実行しなければ.

デフォルトは環境変数の値である CODE_SIGN_IDENTITY これは，Xcodeによってスクリプト生成フェーズのために設定されているか，または None この変数が設定されていなければ.

applehelp_codesign_flags¶

A list 伝達する他のパラメータは codesign ヘルプブックに署名した時。

デフォルトは環境変数に基づく値のリストである. OTHER_CODE_SIGN_FLAGS これは，Xcodeによってスクリプト構築フェーズのために設定されており，その変数が設定されていなければ空リストを返す.

applehelp_indexer_path¶: へと続く. hiutil プログラムです。黙認する. '/usr/bin/hiutil' それがそうです。

applehelp_codesign_path¶: へと続く. codesign プログラムです。黙認する. '/usr/bin/codesign' それがそうです。

applehelp_disable_external_tools¶

もし True したがって，どのような他の設定を指定しても，ジェネレータはインデックスやコード署名ツールを実行しない.

これは主にテストに使用されるか、または非MacOSXプラットフォーム上でSphinx構築を実行し、その後、何らかの理由でOSX上で最後のステップを完了することを望んでいます。

黙認する. False それがそうです。

Epub出力オプション¶

これらのオプションはepub出力に影響を与える.このビルダはHTMLビルダから派生するため，HTMLオプションは適切な場所にも適用可能である.いくつかの選択肢の実際の値は重要ではありません入力するだけで Dublin Core metadata それがそうです。

epub_basename¶: Epubファイルの基本名。それはデフォルトで project 名前。

epub_theme¶: Epubが出力するHTMLトピック.デフォルトのトピックは小画面空間に対して最適化されていないため、HTMLおよびepub出力に同じトピックを使用することは、一般に賢明ではない。このデフォルト値は 'epub' これは視覚空間を節約するために設計されたテーマです

epub_theme_options¶: 選択されたトピックの外観に影響を与えるオプション辞書。これらは特定のテーマです。内蔵テーマ理解に関するオプションは、ご参照ください this section それがそうです。

バージョン 1.2 で追加.

epub_title¶: 文書のタイトル。それはデフォルトで html_title オプションですが、epubのための個別設定を作成することができます。それはデフォルトで project 選択します。

バージョン 2.0 で変更: それはデフォルトで project 選択します。

epub_description¶: 文書の説明。デフォルト値は 'unknown' それがそうです。

バージョン 1.4 で追加.

バージョン 1.5 で変更: 名前を立て直す epub3_description

epub_author¶: 文書の著者。これはダブリンのコアメタデータに含まれている。それはデフォルトで author 選択します。

epub_contributor¶: EPUB出版物のコンテンツ作成過程で副次的な役割を果たす者、組織等の名称。デフォルト値は 'unknown' それがそうです。

バージョン 1.4 で追加.

バージョン 1.5 で変更: 名前を立て直す epub3_contributor

epub_language¶: 文書の言語。これはダブリンのコアメタデータに含まれている。デフォルト値は language オプションや 'en' 設定されていなければ。

epub_publisher¶: 文書の発行者。これはダブリンのコアメタデータに含まれている。項目ホームページのような合理的な文字列を使用することができます。デフォルト設定は author 選択します。

epub_copyright¶: 文書の著作権。それはデフォルトで copyright オプションですが、epubのための個別設定を作成することができます。

epub_identifier¶: 文書の識別子。これはダブリンのコアメタデータに含まれている。発行されたファイルについては、ISBN番号ですが、プロジェクトホームページのような代替案を使用することもできます。デフォルト値は 'unknown' それがそうです。

epub_scheme¶: 出版されています epub_identifier それがそうです。これはダブリンのコアメタデータに含まれている。出版された本については 'ISBN' それがそうです。プロジェクトのホームページを使うと 'URL' 合理的に見えます。デフォルト値は 'unknown' それがそうです。

epub_uid¶: 文書の一意の識別子。これはダブリンのコアメタデータに含まれている。ご利用いただけます XML's Name format 弦楽です。1文字目としてハイフン，句読点，数字を用いることはできない.デフォルト値は 'unknown' それがそうです。

epub_cover¶

表紙情報。これは，表紙画像とHTMLテンプレートのファイル名を含むタプルである.最初の項目としてhtml表紙が挿入されています content.opf それがそうです。テンプレートファイル名が空であれば、html表紙は作成されません。タプルが空であれば、表紙は全く作成されない。例：

epub_cover = ('_static/cover.png', 'epub-cover.html')
epub_cover = ('_static/cover.png', '')
epub_cover = ()

デフォルト値は () それがそうです。

バージョン 1.1 で追加.

epub_css_files¶: CSSファイルリスト。項目はそうでなければならない ファイル名 文字列または含まれている ファイル名 文字列と属性辞書です。詳細についてはご参照ください html_css_files それがそうです。

バージョン 1.8 で追加.

epub_guide¶

誘導要素のメタデータです content.opf それがそうです。これはメタグループの配列です type vt.的 uri そして タイトル オプションでガイド情報の一部。OPF文書、URLを参照してください http://idpf.org/epub もっと細かいことを知っています。もし可能であれば、 ふた. そして toc タイプは自動的に挿入されます。しかしながら、デフォルトエントリが適切でない場合、これらのタイプを明示的にカバーすることができる。例：：

epub_guide = (('cover', 'cover.html', u'Cover Page'),)

デフォルト値は () それがそうです。

epub_pre_files¶

Sphinxが生成したテキストの前に挿入すべき添付ファイル.ファイル名とタイトルを含むタプルリストである。タイトルが空であれば、 toc.ncx それがそうです。例：：

epub_pre_files = [
    ('index.html', 'Welcome'),
]

デフォルト値は [] それがそうです。

epub_post_files¶: Sphinxが生成したテキストの後に挿入すべき添付ファイル.ファイル名とタイトルを含むタプルリストである。このオプションは、付録を追加するために使用できます。タイトルが空であれば、 toc.ncx それがそうです。デフォルト値は [] それがそうです。

epub_exclude_files¶: Buildディレクトリで生成/コピーされますが、epubファイルに含まれるファイルリストではありません。デフォルト値は [] それがそうです。

epub_tocdepth¶: ファイル中のコンテンツリストの深さ toc.ncx それがそうです。それはゼロより大きい整数であるべきだ。デフォルト値は3です。注意：入れ子の深いディレクトリはナビゲーションが困難である可能性がある.

epub_tocdup¶: このフラグは、そのネストされたTOCリストの開始にTOCエントリが再挿入されたか否かを判定する。これは、章の上部により容易にナビゲートすることができるが、異なる深さのエントリを1つのリストに混合するので困惑する可能性がある。デフォルト値は True それがそうです。

epub_tocscope¶

これはepubディレクトリを制御する範囲を設定する.この設定は、次の値を有することができる。

'default' --隠されていないディレクトリエントリ(デフォルト)がすべて含まれています。
'includehidden' --すべてのディレクトリエントリが含まれています。

バージョン 1.2 で追加.

epub_fix_images¶: このフラグは、いくつかのepubリーダーがサポートしていない画像フォーマットの修復を試みるべきかどうかを判断する。現在、小色テーブル付きパレット画像がアップグレードされています。このオプションを使用するには、Pillow(Python画像ライブラリ)をインストールする必要があります。デフォルト値は False 自動変換で情報が失われる可能性があるからです。

バージョン 1.2 で追加.

epub_max_image_width¶: このオプションは、画像の最大幅を指定します。ゼロよりも大きい値に設定されている場合、所与の値よりも大きい幅を有する画像は、対応するスケーリングされる。ゼロであれば、スケーリングは実行されない。デフォルト値は 0 それがそうです。このオプションを使用するには、Python Image Library(Pillow)をインストールする必要があります。

バージョン 1.2 で追加.

epub_show_urls¶

URLアドレスを表示するかどうかを制御する.これは，リンクURLを他の方式で表示していない読者にとって非常に有用である.これらの設定は、次の値を有することができる。

'inline' --括弧内にURL(デフォルト)を内接で表示します。
'footnote' --脚注にURLが表示されます。
'no' --URLは表示されません

クラスにCSSルールを追加することでイントラネットURLの表示を定義することができる. link-target それがそうです。

バージョン 1.2 で追加.

epub_use_index¶: Trueであれば，epub文書にインデックスを付与する.それはデフォルトで html_use_index オプションですが、epubのための個別設定を作成することができます。

バージョン 1.2 で追加.

epub_writing_mode¶

これは書き込み方向を指定する.それは受け入れられます 'horizontal' (デフォルト)と 'vertical'

`epub_writing_mode`	`'horizontal'`	`'vertical'`
書き込みモード 2	`horizontal-tb`	`vertical-rl`
ページの進度	左から右へ	右から左へ
IBookのスクロールテーマサポート	ローラ軸は垂直である。	ロール軸は水平です。

2: https://developer.mozilla.org/en-US/docs/Web/CSS/writing-mode

LaTeX出力オプション¶

これらのオプションはLaTeX出力に影響を与える.

latex_engine¶

文書を構築するためのLaTeXエンジン。この設定は、次の値を有することができる。

'pdflatex' --PDFLaTeX(デフォルト)
'xelatex' --XeLaTeX
'lualatex' -LuaLaTeX
'platex' --Platex(デフォルト値は language はい。 'ja' ）
'uplatex' --upLaTeX(試験)

'pdflatex' Unicode文字のサポートは限られています。

注釈

2.0増加 'pdflatex' 時々シリル文字やギリシャ文字や単語を使用するラテン語文書をサポートする。これは自動ではありませんので、参照してください latex_elements 'fontenc' 鍵です。

項目がUnicode文字を使用する場合は、エンジンを設定してください 'xelatex' あるいは…。 'lualatex' また，十分な広字形カバー範囲を持つOpenTypeフォントを用いることを確保することは通常よりも作成を試みている. 'pdflatex' 追加のUnicode文字を使用します。Sphinx 2.0から始まり、デフォルトはGNU FreeFontであり、ラテン語、シリルヴィン、ギリシャ語をよくカバーしている。

バージョン 2.1.0 で変更: 使用 xelatex (ラテックス包装と xeCJK )デフォルトの場合、中国語文書に使用されます。

バージョン 2.2.1 で変更: 使用 xelatex ギリシャ語文書については、デフォルトで設定されている。

バージョン 2.3 で変更: 増列する. uplatex 応援します。

Contrarily to MathJaX math rendering in HTML output, LaTeX requires some extra configuration to support Unicode literals in math: the only comprehensive solution (as far as we know) is to use 'xelatex' or 'lualatex' and to add r'\usepackage{unicode-math}' (e.g. via the latex_elements 'preamble' key). You may prefer r'\usepackage[math-style=literal]{unicode-math}' to keep a Unicode literal such as α (U+03B1) for example as is in output, rather than being rendered as \(\alpha\).

latex_documents¶

この値は、LaTeXソースファイルに文書ツリーをどのようにグループ化するかを決定する。タプルリストでなければなりません (startdocname, targetname, title, author, theme, toctree_only) そのうちの項目は以下のとおりである.

Startdocname: 文字列、その文字列指定 document name ラテックス文書の主文書。引用されたすべての文書 StartDoc ディレクトリ木中の文書はLaTeXファイルに含まれる.(LaTeXバージョンのデフォルトマスター文書を使用する場合は、提供してください master_doc ここです。)
目標名: ディレクトリ中のLaTeXファイルのファイル名を出力します。
タイトル: LaTeX文書タイトル。空のために使うことができる StartDoc 書類です。これはLaTeXタグとして挿入されるため，リテラルに特殊な文字(逆スラッシュや与号のような)を挿入するためには，それらを正しいLaTeXコマンドを用いて表現しなければならない.
作者: LaTeX文書の著者。以下と同様のLaTeX値上げ警告 タイトル 適用する。使用 \\and 複数の著者を分離するためには、以下の操作を実行してください。 'John \\and Sarah' (逆スラッシュはLaexに到達するためにPython変換でなければなりません)。
主旋律.: ラテックステーマ。見 latex_theme それがそうです。
toctree_only: きっと True あるいは…。 False それがそうです。もし本当なら StartDoc 出力には文書自体は含まれておらず，ディレクトリ木で参照されている文書のみが含まれている.このオプションを使用して、LaTeX出力ではなく、HTMLに表示されたマスタ文書に追加のコンテンツを入れることができます。

バージョン 1.2 で追加: 過去には、ご自身を含むDocumentクラスは、Documentクラス名の前に文字列“sphinx”を付ける必要がありました。これはもう必要ありません。

バージョン 0.3 で追加: 第六条 toctree_only それがそうです。5つの項目を含むタプルは依然として受け入れられている.

latex_logo¶: 与えられた場合、これは、文書のロゴである画像ファイルの名前(構成ディレクトリに対する)でなければならない。バナーページの上部に配置されている。デフォルト： None それがそうです。

latex_toplevel_sectioning¶

This value determines the topmost sectioning unit. It should be chosen from 'part', 'chapter' or 'section'. The default is None; the topmost sectioning unit is switched by documentclass: section is used if documentclass will be howto, otherwise chapter will be used.

LaTeXが使用すれば \part 命令は，LaTeX番号が連続しているため，レベルレベルの深さのセグメントユニットの番号はHTML番号と同期しない. \chapter (または) \section 上の howto ()

バージョン 1.4 で追加.

latex_appendices¶: 付録としてすべてのマニュアルの文書名リストに付加する.

latex_domain_indices¶

Trueであれば，通常のインデックスを生成するほか，ドメイン固有のインデックスを生成する.例えば、Pythonドメインの場合、これはグローバルモジュールインデックスです。デフォルト値は True それがそうです。

この値は、ブール値であってもよいし、FORのように生成すべきインデックス名のリストであってもよい html_domain_indices それがそうです。

バージョン 1.0 で追加.

latex_show_pagerefs¶: Trueであれば，内部参照の後にページ参照を加える.これはマニュアルのコピーを印刷するのに非常に有用だ。デフォルト値は False それがそうです。

バージョン 1.0 で追加.

latex_show_urls¶

URLアドレスを表示するかどうかを制御する.これはマニュアルのコピーを印刷するのに非常に有用だ。この設定は、次の値を有することができる。

'no' --URLは表示されません(デフォルト)
'footnote' --脚注にURLが表示されます。
'inline' --URLは括弧内に内接で表示されています。

バージョン 1.0 で追加.

バージョン 1.1 で変更: この値は現在文字列である；以前はブール値であったが、 'inline' 展示します。後方互換性のためには True まだ受け入れられています

latex_use_latex_multicolumn¶

The default is False: it means that Sphinx's own macros are used for merged cells from grid tables. They allow general contents (literal blocks, lists, blockquotes, ...) but may have problems if the tabularcolumns directive was used to inject LaTeX mark-up of the type >{..}, <{..}, @{..} as column specification.

設定は True LaTeX標準の手段を使って \multicolumn これは，表が使用されていれば，水平マージセル中の文字ブロックと互換性がない tabulary それがそうです。

バージョン 1.6 で追加.

latex_use_xindy¶

もし True Sphinxで作成されたLaTeXファイルから生成されたPDFが使用されます xindy (doc__) ではなく makeindex 一般用語索引を作成する(自 index 用法)。これはUTF-8文字を持つ単語が language それがそうです。

以下の場合は，この選択肢を無視する. latex_engine はい。 'platex' (日本語の書類； mendex 代わりに makeindex そして)。
黙認する. True 上の 'xelatex' あるいは…。 'lualatex' として makeindex 任意のインデックス項目が非ASCII文字で先頭にある場合、作成される .ind UTF−8エンコード無効バイトを含むファイル。使用 'lualatex' これによりPDF構築が破壊される.
黙認する. False 上の 'pdflatex' でも. True いくつかのインデックス項目が言語スクリプト中の非ASCII文字を使用する場合には，ただちに非英語文書に使用することを提案する.

ライオンの顔像が増えました xindy 基本発行版は専用のサポートを行っております 'pdflatex' エンジンにはシリルヴィンスクリプトを用いた.使っても使わなくても 'pdflatex' あるいはUnicodeエンジン，シリル文書はラテン語名のインデックスを正しく扱うことができ，変音符号を用いても同様である.

バージョン 1.8 で追加.

latex_elements¶: バージョン 0.5 で追加.

ITS.ITS documentation もう引っ越しましたラテックスカスタマイズそれがそうです。

latex_docclass¶: 辞書マッピング 'howto' そして 'manual' 2つのSphinxクラスの基礎となる実際の文書クラスの名前を設定する.デフォルトの場合、使用 'article' 上の 'howto' そして 'report' 上の 'manual' それがそうです。

バージョン 1.0 で追加.

バージョン 1.5 で変更: 日本語の文書では (language はい。 'ja' )、デフォルトの場合 'jreport' 使用する 'howto' そして 'jsbook' 上の 'manual' それがそうです。

latex_additional_files¶

LaTeX出力を生成する際にBuildディレクトリのファイル名リスト(プロファイルディレクトリに対する)にコピーする.これは、例えば、追加されたカスタムLaTeXにおいてこれらのファイルが参照されていれば、Sphinxが自動的に複製されないファイルを複製するために非常に有用である。 latex_elements それがそうです。ソースファイルから参照される画像ファイル(例えば、 .. image:: )が自動的にコピーされます。

ファイル名が自動コピーされたファイル名と競合しないことを確実にしなければなりません。

バージョン 0.6 で追加.

バージョン 1.2 で変更: これはSphinxが提供するファイル、例えば sphinx.sty それがそうです。

latex_theme¶

LaTeXは使用すべき“テーマ”を出力する.これはLaTeX出力設定のセット(例えば文書クラス，トップパーティションユニットなど).

内蔵されたラテックスのテーマとして manual そして howto すべて束ねられています。

manual: マニュアルを作成するためのラテックステーマ。それは導入されます report Documentクラス(日本語文書使用 jsbook ）。
howto: 文章を書くためのラテックステーマです。それは導入されます article Documentクラス(日本語文書使用 jreport )である。 latex_appendices このテーマにのみ適用される。

デフォルト値は 'manual' それがそうです。

バージョン 3.0 で追加.

latex_theme_options¶: 選択されたトピックの外観に影響を与えるオプション辞書。

バージョン 3.1 で追加.

latex_theme_path¶: サブディレクトリであるカスタムLaTeX引数を含むルーティングテーブル.相対パスは構成ディレクトリに対してとみなされる.

バージョン 3.0 で追加.

テキスト出力のためのオプション¶

これらのオプションはテキスト出力に影響を与える.

text_newlines¶

テキスト出力に用いる行末尾文字を決定する.

'unix' ：Unixスタイルを用いた行尾 (\n ）
'windows' ：Windowsスタイルを用いた行尾 (\r\n ）
'native' ：文書を構築するプラットフォームを用いた行尾スタイル

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

バージョン 1.1 で追加.

text_sectionchars¶

1つの7文字の文字列は，部分に下線を引くのに適用される.第1の文字は一次タイトルに使用され、第2の文字は二次タイトルに使用され、以下同様である。

黙認する. '*=-~"+`' それがそうです。

バージョン 1.1 で追加.

text_add_secnumbers¶: テキスト出力に節番号が含まれているかどうかを決定するブール値である.デフォルト値は True それがそうです。

バージョン 1.7 で追加.

text_secnumber_suffix¶: テキストは中節番号の接尾辞を出力するデフォルト： ". " それがそうです。とする. " " 節番号上の最後の点をキャンセルする場合は、以下の操作を実行してください。

バージョン 1.7 で追加.

マニュアルページ出力オプション¶

これらのオプションは、マニュアルページの出力に影響を与えます。

man_pages¶

この値は、文書ツリーをマニュアルページにどのようにグループ化するかを決定する。タプルリストでなければなりません (startdocname, name, description, authors, section) そのうちの項目は以下のとおりである.

Startdocname: 文字列、その文字列指定 document name マニュアルページの主文書。引用されたすべての文書 StartDoc ディレクトリツリー内の文書はマニュアルファイルに含まれる.(デフォルトマスター文書を使用してマニュアルページを生成する場合は、ご利用ください master_doc ここです。)
name: マニュアルページの名前。これはスペースや特殊な文字を持たない短い文字列でなければならない。マニュアルページのファイル名および名前(名前部分)を決定するために使用される。
説明する.: マニュアルページの説明。これは名前部分で使用される.
作者: 著者の文字列リスト、または単一の文字列を持っています。マニュアルページに著者部分を自動生成したくなければ、空文字列やリストであってもよい。
セグメント化する.: マニュアルページ部分。ファイル名およびマニュアルページタイトルを出力するために用いられる.

バージョン 1.0 で追加.

man_show_urls¶: Trueであれば，リンク後にURLアドレスを付加する.デフォルト値は False それがそうです。

バージョン 1.1 で追加.

man_make_section_directory¶: Trueの場合は、構築マニュアルページ上にパーティションディレクトリを作成します。デフォルト値はFalseである.

バージョン 3.3 で追加.

テクスチャ情報出力オプション¶

これらのオプションはTexinfo出力に影響を与える.

texinfo_documents¶

この値は、文書ツリーをTexinfoソースファイルにどのようにグループ化するかを決定する。タプルリストでなければなりません (startdocname, targetname, title, author, dir_entry, description, category, toctree_only) そのうちの項目は以下のとおりである.

Startdocname: 文字列、その文字列指定 document name テクスチャ情報ファイルのメイン文書.引用されたすべての文書 StartDoc ディレクトリツリー中の文書はTexinfoファイルに含まれる.(Texinfoバージョンのデフォルトのマスターファイルを使用したい場合は、ご提供ください master_doc ここです。)
目標名: ディレクトリ中のTexinfoファイルのファイル名(拡張子なし)を出力します。
タイトル: テキスト情報文書タイトル。空のために使うことができる StartDoc 書類です。Texinfoタグとして挿入されるため，このような特殊な文字 @ そして {{}} 直接挿入するためには変換が必要だ。
作者: Texinfo文書の著者。テクスチャ情報タグとして挿入する.使用 @* 複数の著者を分離するためには、以下の操作を実行してください。 'John@*Sarah' それがそうです。
dir_entry: トップレベルの名前に現れます DIR メニューファイル。
説明する.: トップに表示される記述テキストは DIR メニューファイル。
カテゴリー.カテゴリー: このエントリがトップレベルに表示される節を指定する DIR メニューファイル。
toctree_only: きっと True あるいは…。 False それがそうです。もし本当なら StartDoc 出力には文書自体は含まれておらず，ディレクトリ木で参照されている文書のみが含まれている.このオプションを使用して、HTMLに表示されているマスタ文書に追加のコンテンツを入れることができますが、Texinfo出力に入れることはできません。

バージョン 1.1 で追加.

texinfo_appendices¶: 付録としてすべてのマニュアルの文書名リストに付加する.

バージョン 1.1 で追加.

texinfo_domain_indices¶

Trueであれば，通常のインデックスを生成するほか，ドメイン固有のインデックスを生成する.例えば、Pythonドメインの場合、これはグローバルモジュールインデックスです。デフォルト値は True それがそうです。

この値は、ブール値であってもよいし、FORのように生成すべきインデックス名のリストであってもよい html_domain_indices それがそうです。

バージョン 1.1 で追加.

texinfo_show_urls¶

URLアドレスの表示方法を制御する.

'footnote' --脚注にURL(デフォルト)を表示します。
'no' --URLは表示されません
'inline' --URLは括弧内に内接で表示されています。

バージョン 1.1 で追加.

texinfo_no_detailmenu¶: Trueであれば生成しない. @detailmenu “Top”ノードのメニューには，文書中の各子ノードのエントリが含まれる.デフォルト値は False それがそうです。

バージョン 1.2 で追加.

texinfo_elements¶

Texinfo断片を含む辞書であって、これらの断片は、通常、Sphinxが生成されたものをカバーする辞書 .texi ファイルです。

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

'paragraphindent'
各セグメントの1行目に格納されたスペース数、デフォルト値 2 それがそうです。指定 0 くぼみがありません。

'exampleindent'
例または文字ブロックの行をインデントするためのスペース数、デフォルト値 4 それがそうです。指定 0 くぼみがありません。

'preamble'
ファイルの先頭付近に挿入されたTexinfoタグ.

'copying'
中に挿入されたTexinfoタグ @copying ブロックは、タイトルの後に表示される。デフォルト値は，項目を識別する簡単なバナーページからなる.
他のオプションによって設定されているので、カバーされてはいけないポイントは、

'author' 'body' 'date' 'direntry' 'filename' 'project' 'release' 'title'

バージョン 1.1 で追加.

QtHelp出力のオプション¶

これらのオプションはqthelp出力に影響を与える.このビルダはHTMLビルダから派生するため，HTMLオプションは適切な場所にも適用可能である.

qthelp_basename¶: Qthelpファイルの基本名です。それはデフォルトで project 名前。

qthelp_namespace¶: Qthelpファイルの名前空間.デフォルト値は org.sphinx.<project_name>.<project_version> それがそうです。

qthelp_theme¶: Qthelpが出力するHTMLトピック.このデフォルト値は 'nonav' それがそうです。

qthelp_theme_options¶: 選択されたトピックの外観に影響を与えるオプション辞書。これらは特定のテーマです。内蔵テーマ理解に関するオプションは、ご参照ください this section それがそうです。

リンクチェックビルダのオプション¶

linkcheck_ignore¶

操作実行時に検査すべきでないURIに一致する正規表現リスト linkcheck 建てます。例：：

linkcheck_ignore = [r'http://localhost:\d+/']

バージョン 1.1 で追加.

linkcheck_request_headers¶

基URLをHTTPリクエストヘッダの辞書にマッピングする.

キーはURLに基づく文字列であり，以下のようになる. "https://sphinx-doc.org/" それがそうです。他のホストのヘッダを指定するには、以下の操作を実行してください。 "*" 使用できます。URLが他の設定と一致しない場合にのみ、すべてのホストに一致します。

この値は，ヘッダ名をその値にマッピングした辞書である.

例：

linkcheck_request_headers = {
    "https://sphinx-doc.org/": {
        "Accept": "text/html",
        "Accept-Encoding": "utf-8",
    },
    "*": {
        "Accept": "text/html,application/xhtml+xml",
    }
}

バージョン 3.1 で追加.

linkcheck_retries¶: リンクチェック生成器は，あるURLが破損したことを宣言する前にそのURLの回数をチェックしようと試みる.デフォルトは1回の試行である.

バージョン 1.4 で追加.

linkcheck_timeout¶: リンクチェック生成器のタイムアウト値(秒単位)である.デフォルトの場合、Pythonを使用したグローバルソケットはタイムアウトします。

バージョン 1.1 で追加.

linkcheck_workers¶: リンクを検査する際に使用するワークスレッド数.デフォルト値は5つのスレッドである.

バージョン 1.1 で追加.

linkcheck_anchors¶: Trueでしたら、チェックしてください #anchor sはリンクにあります。これは文書全体をダウンロードする必要があるため，有効化時の速度がかなり遅くなる.デフォルト値は True それがそうです。

バージョン 1.2 で追加.

linkcheck_anchors_ignore¶

リンクにおけるアンカの有効性をチェックする際には，アンカSphinxに一致する正規表現リストはスキップすべきである.これにより、ウェブサイトのJavaScriptをスキップして動的ページを制御するアンカに追加するか、または内部REST要求をトリガする際にアンカをスキップすることができる。デフォルト値は ["^!"] それがそうです。

注釈

特定のページのアンカまたは特定のパターンに一致するページのアンカ(ただし、アンカーがない同じページの一致項目をチェックする)を無視する場合は、使用してください linkcheck_ignore 代わりに、例えば、以下のようになる。

linkcheck_ignore = [
   'http://www.sphinx-doc.org/en/1.7/intro.html#'
]

バージョン 1.5 で追加.

linkcheck_auth¶

以下の操作を実行する際に認証情報を伝達する. linkcheck 建てます。

1部の明細書. (regex_pattern, auth_info) プロジェクトの位置のタプル：

regex_pattern: URIにマッチする正規表現.
auth_info: このURIのための認証情報。この値は requests 庫(参照) requests Authentication (詳細は参照)。

♪the linkcheck 生成器は最初のマッチングを使用します auth_info それは linkcheck_auth リスト中の値は，リスト中の早い値が高い優先度を持つ.

例：：

linkcheck_auth = [
  ('https://foo\.yourcompany\.com/.+', ('johndoe', 'secret')),
  ('https://.+\.yourcompany\.com/.+', HTTPDigestAuth(...)),
]

バージョン 2.3 で追加.

linkcheck_rate_limit_timeout¶

♪the linkcheck 建設業者は短時間で同じサイトに大量の要求を出すかもしれない。サーバが要求がレート制限されていることを示す場合、この設定制御生成器動作。

サーバがいつ再試行(使用)を指示した場合 Retry-After タイトル)、 linkcheck 常にサーバの指示に従う.

そうでなければ linkcheck 再試行の前に1分間待ち、成功またはそれ以上になるまで、2つの試行間の待ち時間を2倍に増加させ続ける linkcheck_rate_limit_timeout それがそうです。デフォルトの場合，タイムアウト時間は5分である.

バージョン 3.4 で追加.

XMLビルダのオプション¶

xml_pretty¶: 真であればXMLをきれいに印刷する.デフォルト値は True それがそうです。

バージョン 1.2 で追加.

脚注

1(1,2): A note on available globbing syntax: you can use the standard shell constructs *, ?, [...] and [!...] with the feature that these all don't match slashes. A double star ** can be used to match any sequence of characters including slashes.

Cドメインのオプション¶

c_id_attributes¶: 解析器はまた，属性である文字列のリストを受け取るべきである.例えばこれは属性で #define Dは携帯性を表す。

バージョン 3.0 で追加.

c_paren_attributes¶: A list of strings that the parser additionally should accept as attributes with one argument. That is, if my_align_as is in the list, then my_align_as(X) is parsed as an attribute for all strings X that have balanced braces ((), [], and {}). This can for example be used when attributes have been #define d for portability.

バージョン 3.0 で追加.

c_allow_pre_v3¶: ブール値(デフォルト) False )v 3前のパターンタイプ命令およびタイプロールを解析し、変換しようと試みるかどうかを制御します。

バージョン 3.2 で追加.

バージョン 3.2 で非推奨: V 3で追加されたコマンドとロールを使用する.

c_warn_on_allowed_pre_v3¶: ブール値(デフォルト) True )v 3を解析および変換する前のパターンタイプコマンド/ロールを解析および変換する際に警告を発するかどうかを制御する。

バージョン 3.2 で追加.

バージョン 3.2 で非推奨: V 3で追加されたコマンドとロールを使用する.

C++ドメインのオプション¶

cpp_index_common_prefix¶: グローバルインデックス中のC++オブジェクトをソートする際に無視するプレフィックスリスト.例えば ['awesome_lib::'] それがそうです。

バージョン 1.5 で追加.

cpp_id_attributes¶: 解析器はまた，属性である文字列のリストを受け取るべきである.例えばこれは属性で #define Dは携帯性を表す。

バージョン 1.5 で追加.

cpp_paren_attributes¶: A list of strings that the parser additionally should accept as attributes with one argument. That is, if my_align_as is in the list, then my_align_as(X) is parsed as an attribute for all strings X that have balanced braces ((), [], and {}). This can for example be used when attributes have been #define d for portability.

バージョン 1.5 で追加.

プロファイル例¶

# test documentation build configuration file, created by
# sphinx-quickstart on Sun Jun 26 00:00:43 2016.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))

# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = []

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'

# The encoding of source files.
#
# source_encoding = 'utf-8-sig'

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = u'test'
copyright = u'2016, test'
author = u'test'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = u'test'
# The full version, including alpha/beta/rc tags.
release = u'test'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#
# today = ''
#
# Else, today_fmt is used as the format for a strftime call.
#
# today_fmt = '%B %d, %Y'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# These patterns also affect html_static_path and html_extra_path
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

# The reST default role (used for this markup: `text`) to use for all
# documents.
#
# default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.
#
# add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#
# add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#
# show_authors = False

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# A list of ignored prefixes for module index sorting.
# modindex_common_prefix = []

# If true, keep warnings as "system message" paragraphs in the built documents.
# keep_warnings = False

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False


# -- Options for HTML output ----------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'

# Theme options are theme-specific and customize the look and feel of a theme
# further.  For a list of options available for each theme, see the
# documentation.
#
# html_theme_options = {}

# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []

# The name for this set of Sphinx documents.
# "<project> v<release> documentation" by default.
#
# html_title = u'test vtest'

# A shorter title for the navigation bar.  Default is the same as html_title.
#
# html_short_title = None

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#
# html_logo = None

# The name of an image file (relative to this directory) to use as a favicon of
# the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#
# html_favicon = None

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#
# html_extra_path = []

# If not None, a 'Last updated on:' timestamp is inserted at every page
# bottom, using the given strftime format.
# The empty string is equivalent to '%b %d, %Y'.
#
# html_last_updated_fmt = None

# Custom sidebar templates, maps document names to template names.
#
# html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
#
# html_additional_pages = {}

# If false, no module index is generated.
#
# html_domain_indices = True

# If false, no index is generated.
#
# html_use_index = True

# If true, the index is split into individual pages for each letter.
#
# html_split_index = False

# If true, links to the reST sources are added to the pages.
#
# html_show_sourcelink = True

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#
# html_show_sphinx = True

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#
# html_show_copyright = True

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it.  The value of this option must be the
# base URL from which the finished HTML is served.
#
# html_use_opensearch = ''

# This is the file name suffix for HTML files (e.g. ".xhtml").
# html_file_suffix = None

# Language to be used for generating the HTML full-text search index.
# Sphinx supports the following languages:
#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
#
# html_search_language = 'en'

# A dictionary with options for the search language support, empty by default.
# 'ja' uses this config value.
# 'zh' user can custom change `jieba` dictionary path.
#
# html_search_options = {'type': 'default'}

# The name of a javascript file (relative to the configuration directory) that
# implements a search results scorer. If empty, the default will be used.
#
# html_search_scorer = 'scorer.js'

# Output file base name for HTML help builder.
htmlhelp_basename = 'testdoc'

# -- Options for LaTeX output ---------------------------------------------

latex_elements = {
    # The paper size ('letterpaper' or 'a4paper').
    #
    # 'papersize': 'letterpaper',

    # The font size ('10pt', '11pt' or '12pt').
    #
    # 'pointsize': '10pt',

    # Additional stuff for the LaTeX preamble.
    #
    # 'preamble': '',

    # Latex figure (float) alignment
    #
    # 'figure_align': 'htbp',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
#  author, documentclass [howto, manual, or own class]).
latex_documents = [
    (master_doc, 'test.tex', u'test Documentation',
     u'test', 'manual'),
]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
#
# latex_logo = None

# If true, show page references after internal links.
#
# latex_show_pagerefs = False

# If true, show URL addresses after external links.
#
# latex_show_urls = False

# Documents to append as an appendix to all manuals.
#
# latex_appendices = []

# If false, no module index is generated.
#
# latex_domain_indices = True


# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    (master_doc, 'test', u'test Documentation',
     [author], 1)
]

# If true, show URL addresses after external links.
#
# man_show_urls = False


# -- Options for Texinfo output -------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
#  dir menu entry, description, category)
texinfo_documents = [
    (master_doc, 'test', u'test Documentation',
     author, 'test', 'One line description of project.',
     'Miscellaneous'),
]

# Documents to append as an appendix to all manuals.
#
# texinfo_appendices = []

# If false, no module index is generated.
#
# texinfo_domain_indices = True

# How to display URL addresses: 'footnote', 'no', or 'inline'.
#
# texinfo_show_urls = 'footnote'

# If true, do not generate a @detailmenu in the "Top" node's menu.
#
# texinfo_no_detailmenu = False

# -- A random example -----------------------------------------------------

import sys, os
sys.path.insert(0, os.path.abspath('.'))
exclude_patterns = ['zzz']

numfig = True
#language = 'ja'

extensions.append('sphinx.ext.todo')
extensions.append('sphinx.ext.autodoc')
#extensions.append('sphinx.ext.autosummary')
extensions.append('sphinx.ext.intersphinx')
extensions.append('sphinx.ext.mathjax')
extensions.append('sphinx.ext.viewcode')
extensions.append('sphinx.ext.graphviz')


autosummary_generate = True
html_theme = 'default'
#source_suffix = ['.rst', '.txt']

Table of Contents

前のトピックへ

次のトピックへ

配置¶

プロジェクト情報¶

通常の構成¶

国際化オプション¶

数学的選択肢¶

HTML出力用オプション¶

単一のHTML出力のためのオプション¶

HTMLヘルプを出力するためのオプション¶

Appleはオプションの出力を支援します¶

Epub出力オプション¶

LaTeX出力オプション¶

テキスト出力のためのオプション¶

マニュアルページ出力オプション¶

テクスチャ情報出力オプション¶

QtHelp出力のオプション¶

リンクチェックビルダのオプション¶

XMLビルダのオプション¶

Cドメインのオプション¶

C++ドメインのオプション¶

プロファイル例¶