Sphinxが追加したDoctreeノードクラス

ドメイン固有のオブジェクト記述のノード

class sphinx.addnodes.desc(rawsource='', *children, **attributes)

オブジェクト記述のノード.

このノードは，1つの定義しかない“定義リスト”に類似している.1つ以上のものが含まれています desc_signature 1つと desc_content それがそうです。

class sphinx.addnodes.desc_signature(rawsource='', text='', *children, **attributes)

対象署名のノード.

Sphinx定義リスト中の“Term”部分をカスタマイズする.

デフォルトの場合、署名は単行署名であるが、設定は is_multiline = True 複数行の署名を記述する場合は，以下の操作を実行してください.この場合，すべての子ノードが必要である. desc_signature_line ノードです。

class sphinx.addnodes.desc_signature_line(rawsource='', text='', *children, **attributes)

ノードは行中の複数行オブジェクト署名である.

それはただ desc_signature 使用 is_multiline 準備ができました。集 add_permalink = True 永久リンクを取得すべき経路である.

class sphinx.addnodes.desc_addname(rawsource='', text='', *children, **attributes)

その他の名前部分(モジュール名，クラス名)のノード.

class sphinx.addnodes.desc_type(rawsource='', text='', *children, **attributes)

タイプまたはオブジェクトタイプ名のノードを返します。

class sphinx.addnodes.desc_returns(rawsource='', text='', *children, **attributes)

ノードは“戻る”注釈を表します(Pythonではla->)。

class sphinx.addnodes.desc_name(rawsource='', text='', *children, **attributes)

主オブジェクト名のノード.

class sphinx.addnodes.desc_parameterlist(rawsource='', text='', *children, **attributes)

通常パラメータリストのノード.

class sphinx.addnodes.desc_parameter(rawsource='', text='', *children, **attributes)

ノードは単一のパラメータに使用される.

class sphinx.addnodes.desc_optional(rawsource='', text='', *children, **attributes)

ノードは、パラメータリストのオプション部分をマークするために使用される。

class sphinx.addnodes.desc_annotation(rawsource='', text='', *children, **attributes)

署名書き込み(Python 3スタイル書き込みではありません)のノードです。

class sphinx.addnodes.desc_content(rawsource='', *children, **attributes)

オブジェクト記述内容のノード.

これはカスタムSphinx定義リストの“定義”部分である.

新警告式構造

class sphinx.addnodes.versionmodified(rawsource='', text='', *children, **attributes)

バージョン変更エントリのノード。

現在、“バージョン追加”、“バージョン変更”、“破棄”命令で使用されています。

class sphinx.addnodes.seealso(rawsource='', *children, **attributes)

習俗は“別見”を戒める。

他段落レベルノード

class sphinx.addnodes.compact_paragraph(rawsource='', text='', *children, **attributes)

コンパクトパラグラフのためのノード(決して<p>ノードは生成されない).

内部接続ノードを新規に新設する.

class sphinx.addnodes.index(rawsource='', text='', *children, **attributes)

インデックス項目のノード.

このノードは index 命令は属性を持っています entries それがそうです。その値は5元グループからなるリストです (entrytype, entryname, target, ignored, key) それがそうです。

エントリタイプ “単”“対”“双”“三”の一種である。

key 通常のインデックスページの分類文字(通常は単一文字)である。詳細については，別に参照されたい glossary 第2320号です

class sphinx.addnodes.pending_xref(rawsource='', *children, **attributes)

交差引用のノードは，すべての文書に関する完全な情報がなければ，これらの交差引用を解析することはできない.

出力を書き込む前に，BuildEnvironmentでこれらのノードを解析する.RESOLVE_REFERENCES。

class sphinx.addnodes.literal_emphasis(rawsource='', text='', *children, **attributes)

行動類似ノード emphasis しかし、他のテキストプロセッサ(例えば、HTML出力のためのSmartyants)は適用されない。

class sphinx.addnodes.abbreviation(rawsource: str = '', text: str = '', *children: docutils.nodes.Node, **attributes: Any)

縮約とその解釈のノード。

バージョン 2.0 で非推奨.

class sphinx.addnodes.download_reference(rawsource='', text='', *children, **attributes)

参照をダウンロードするためのノードは、Pending_xrefと同様である。

特殊ノード.

class sphinx.addnodes.only(rawsource='', *children, **attributes)

“Only”命令のノード(タグに基づく条件は含む).

class sphinx.addnodes.meta(rawsource='', *children, **attributes)

Meta命令のノードであるdocutilsの標準メタノードと同じであるが，ピックアップ可能である.

class sphinx.addnodes.highlightlang(rawsource='', *children, **attributes)

後続のコードブロックの強調表示言語および行番号オプションを設定するために挿入されます。

Extensionsで次のノードを生成する必要はないはずです。

class sphinx.addnodes.glossary(rawsource='', *children, **attributes)

ノードは語彙表を挿入する.

class sphinx.addnodes.toctree(rawsource='', *children, **attributes)

“ディレクトリツリー”を挿入するためのノード.

class sphinx.addnodes.start_of_file(rawsource='', *children, **attributes)

ノードタグの新しいファイルの開始は，LaTeX生成器でのみ使用される.

class sphinx.addnodes.productionlist(rawsource='', *children, **attributes)

構文生成式リストのノード.

ハム production ノードです。

class sphinx.addnodes.production(rawsource='', text='', *children, **attributes)

ノードは，単一の文法生成規則に用いられる.