sphinx_gallery.block_parser

BlockParser は、`.py` 以外のソースファイルをコードブロックとマークアップテキストのブロックに分割します。

クラス

class sphinx_gallery.block_parser.BlockParser(source_file, gallery_conf)

ソースファイルをコードブロックとマークアップテキストのブロックに分割するパーサーです。

ソース言語を決定し、pygments を使用してコメントブロックを識別します。

パラメーター：

• source_file (str) – 後続の解析と互換性のあるサフィックスを持つファイル名

• gallery_conf (dict) – Sphinx-Gallery の設定を含みます。

extract_file_config(content)

docstring で指定されたファイル固有の設定を取り出します。

remove_config_comments(code_block)

ファイル内設定コメントが削除されたcode_blockの内容を返します。

行コメント文字の後に続くパターンsphinx_gallery_[option] = [val]を持つコメント行は削除されますが、周囲の空行は保持されます。

パラメーター：

code_block (str) – コードセグメント。

remove_ignore_blocks(code_block)

無視された領域が削除されたcode_blockの内容を返します。

無視ブロックは?? sphinx_gallery_start_ignoreで始まり、?? sphinx_gallery_end_ignoreで終わります。??はアクティブな言語の行コメントマーカーです。これらの行とその間のすべてのものは削除されますが、周囲の空行は保持されます。

パラメーター：

code_block (str) – コードセグメント。

split_code_and_text_blocks(source_file, return_node=False)

ソースファイルをコードブロックとテキストブロックに分割したリストを返します。

パラメーター：

• source_file (str) – ソースファイルへのパス。

• return_node (bool) – 無視されます。astノードの返却はサポートされていません。

戻り値：

• file_conf (dict) – ソースファイルのコメントに# sphinx_gallery_<name> = <value>として与えられたファイル固有の設定。

• blocks (list) – (ラベル、コンテンツ、行番号) 各要素がラベル（'text' または 'code'）、対応するコンテンツ文字列、および先頭の行番号のタプルであるリスト。

• node (None) – astノードの返却はサポートされていません。