解析器API

The docutils documentation describes _解析器は以下の通りです。

パーサは入力文書を解析してノード木表現を作成する.

Sphinxでは，パーサモジュールの動作方式はdocutilsと同様である.パーサは、アプリケーションAPIの拡張を使用してSphinxに登録する。 Sphinx.add_source_suffix() そして Sphinx.add_source_parser() それがそうです。

♪the 源接尾辞 ファイル接尾辞からファイルタイプへのマッピングである.例えば .rst ファイルがマッピングされています 'restructuredtext' タイプです。Sphinxは、このファイルタイプを使用して登録リストからパーサを検索します。検索についてSphinxとは Parser.supported 属性は、当該属性中のファイルタイプを含む解析器を選択する。

ユーザは、以下のコマンドカバーソース接尾辞マッピングを使用することができます source_suffix 以下に示す.

# a mapping from file suffix to file types
source_suffix = {
    '.rst': 'restructuredtext',
    '.md': 'markdown',
}

パーサによってサポートされるファイルタイプを指定しなければなりません。これにより、ユーザがその設定を適切に構成することができる。

class sphinx.parsers.Parser

ソースコード解析器の基本クラス.他の解析器はこれを継承すべきです docutils.parsers.Parser それがそうです。と比較する． docutils.parsers.Parser このクラスは、Sphinx APIへのアクセス可能性を改善する。

サブクラスは，以下のオブジェクトと関数にアクセスすることができる：

self.app

アプリケーションオブジェクト (sphinx.application.Sphinx ）

self.config

配置対象 (sphinx.config.Config ）

self.env

環境対象 (sphinx.environment.BuildEnvironment ）

Self.warn()

警告を発する。(と) sphinx.application.Sphinx.warn() ）

Self.info()

情報的なメッセージを送ります(と) sphinx.application.Sphinx.info() ）

バージョン 1.6 で非推奨: warn() そして info() 賛成しません。使用 sphinx.util.logging 代わりに。

バージョン 3.0 で非推奨: Parser.appは使用されていません。