Engineer as a Lifestyle @tenkoma

What We Find Changes Who We Become -- Peter Morville著『アンビエント・ファインダビリティ 』

Read the Docs にあるドキュメント(Sphinx) で引用符が "「", "」" などに変換されるのを防止する

PHPUnit のドキュメントは reStructuredTextというマークアップ言語で記述され、Sphinx というビルドツールでHTMLなどのフォーマットに変換されている。Sphinx によるビルドはRead the Docsというドキュメントホスティングサービス上で実行される。

Sphinx で使っている docutils の機能かと思うが、引用符 "' を各自然言語ごとにローカライズされた引用符に変換する機能があり、既定で有効になっている。日本語だと , , に変換される。

便利な場面もあるが、英単語、英文の場合は英語版と同じ , が見やすく感じるし、全体的にそれでもよさそうに思う。, を使おうと思えば翻訳時に使えるので。

そこで調査してプルリクエストを作った

必要な修正は

  • docutils は 0.14以上を使うようにする
  • docutils.conf に日本語の引用符スタイルに使う文字の設定を書く

となる。

以上。