Sphinx拡張

より​一般的な​ユースケースへの​対応と​して、​Sphinx拡張と​して​使用する​ことが​出来ます。

セットアップ

インストール を​もとに​インストールを​実施後、​Sphinxドキュメントの​ conf.py に​Sphinx拡張の​登録を​してください。

conf.py

extensions = [
    "rst_budoux.sphinx",
]

動作

この​ライブラリは​新しい​ビルダーを​提供しないため、​普段ど​おりに​ドキュメントの​ビルドを​行ってください。

設定

動作を​調整する​ために、​いく​つかの​設定項目が​あります。

budoux_separator

Type: str

Required: False

Default: "\u200b" (ゼロ幅スペース)

WordBreak ノード(=分かち​書きの​境界)に​挿入する​文字列を​指定します。​ 例えば、​ "<wbr>" のような​指定する​ことで、​HTMLタグの​挿入も​可能です。

budoux_additional_style

Type: str | None

Required: False

Default: None

budoux_separator で​挿入した​文字列向けに、​必要に​応じて​スタイルシートを​記述する​ための​項目です。​ html 系の​ビルダーの​利用時のみ​有効です。

• None ではなく​文字列を​設定する​場合、​ <style> ~~ </style> の​中身と​して​使用します。​ 必ず​文法と​して​正しい​スタイルシート定義と​なるように​してください。

• この​値は​「その​ドキュメントが​ WordBreak ノードを​持つか​否か」に​関わらず、​全ての​ページに​対して​作用します。