ReSTで2つのダッシュを処理する方法

Question

私はSphinxを使ってPythonで書かれたコマンドラインユーティリティを文書化しています。残りの部分で

**--region** <region_name> 

、その後、私のために私のHTMLとマニュアルページを生成するためにスフィンクスを使用します。私は、このようなこのような--regionなどのコマンドラインオプションを、文書化することができるようにしたいです。

マニュアルページを生成するときにはうまくいくが、生成されたHTMLでは--が-になり、間違っている。

**---region** <region_name> 

をHTMLが正しく生成しますが、今の私のmanページが---代わりの--を持っている：私はこのように見えるように私の元のREST文書を変更した場合ことを発見しました。また間違っています。

ダッシュをバックスラッシュ（たとえば、\-\-）でエスケープしようとしましたが、効果がありませんでした。

ご協力いただければ幸いです。

Answer 1

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

このオプションをオフにすると、エンダッシュが必要な場合は、Unicode文字 ' - 'を使用する必要があります。 、2つのダッシュを追加し、以下を追加するには

Answer 2

：

.. include:: <isotech.txt> 

|minus|\ |minus|\ region 

は逆方向スラッシュとスペースに注意してください。これにより、マイナス記号とパラメーターの名前の間にスペースが入りません。

ページあたり1回だけisotech.txtを含める必要があります。

このソリューションを使用すると、拡張スマートアイコンを保持し、必要なテキストのすべての部分に2つのダッシュを書き込むことができます。オプションリストやリテラルだけではありません。

Answer 3

スフィンクスでは、html_use_smartypants = Falseをconf.pyに、またはsphinx-buildの引数として設定する必要はありません。代わりにsmart_quotes = Falseを使用してください。

以前はhtml_use_smartypantsで提供されていた変換を使用する場合は、代わりにsmart_quotes、たとえばsmart_quotes = Trueを使用することをお勧めします。

この記事の執筆時点では、オプションをサポートしていないドキュメントのピンsphinx==1.5.3を読んでください。それまではhtml_use_smartypantsを使用する必要があります。それが動作するはず

**-\\-region** <region_name> 

で

Answer 4

。