Sphinxのロール
以下を知るまでは全て2連バッククォートにしていた
以下のロールは、テキストのスタイルを変更する以外には特別なことはしません。
使うことで書き手も読み手も見やすくなる
VSCodeでは拡張?により、サジェストされる
:command:
rm のような、OSレベルのコマンドの名前に使用します。
:file:
ファイルやディレクトリの名前に使用します。
fileというロール名だが、ディレクトリにも使える!
:guilabel:
インタラクティブなユーザインタフェースの一部のラベルとして表示される文字に対しては guilabel を使用します。
:kbd:
キーボード操作のキーに使用します。
例えば、xemacs キー操作は :kbd:C-x C-f という表現になるでしょう。しかし、特定のアプリケーションやプラットフォームに限定する必要がなければ同じ操作は :kbd:Control-x Control-f と書くべきです。
ロールは追加できる!
setup()関数で実装。拡張扱い