13

Python で記述されたコマンド ライン ユーティリティの文書化に Sphinx を使用しています。次のようなコマンド ライン オプションを文書化できるようにしたいと考えています--region

**--region**  <region_name>

ReST で作成し、Sphinx を使用して HTML と man ページを生成します。

これは、man ページを生成する場合にはうまく機能しますが、生成された HTML では、が正しくないもの--に変わります。-ソースの ReST ドキュメントを次のように変更すると、次のようになることがわかりました。

**---region**  <region_name>

HTML は正しく生成されますが、man ページ---には--. また、不正解です。

バックスラッシュ文字 (例: ) を使用してダッシュをエスケープしようとしました\-\-が、効果はありませんでした。

どんな助けでも大歓迎です。

4

5 に答える 5

4

これは、デフォルトで有効になっている Sphinx の構成オプションです:html_use_smartypantsオプション ( http://sphinx-doc.org/config.html?highlight=dash#confval-html_use_smartypants )。

このオプションをオフにした場合、en-dash が必要な場合は Unicode 文字 '–' を使用する必要があります。

于 2013-03-12T05:44:46.453 に答える