パーサAPI

class sphinx.parsers.Parser[ソース]

ソースパーサのベースクラスです。Sphinx に登録されるパーサは 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() と同じメソッドです)。