1

私は Sphinx を使用して、Python プロジェクトのドキュメントを生成しています。ドキュメントにいくつかのデフォルト値を記述する必要があります。しかし、後で簡単に分岐する可能性があるため、コードから docstring に値をコピーして貼り付けたくありません。質問は次のとおりです。定数への参照をその値で置き換えることは可能ですか?

私はこのようなことについて話している(私は:py:const_value:指令を作った):

DEFAULT = 123

class Foo:
   """Default value for something is :py:const_value:`DEFAULT`."""

そして、私はこのようなドキュメントを取得したいと思います:

何かのデフォルト値は 123 です。

検索してみましたが、残念ながらSphinxにはそのような機能がないか、「定数置換」という用語が適切ではありません。

Sphinx でできない場合、そのような重複を避ける別の方法はありますか?

4

1 に答える 1

2

sphinx のドキュメント ( reStructuredText Primer ) によると、最も近い方法は、マークアップを使用して作成された置換を使用することreplace::です。例えば:

.. |PI| replace:: 3.1415

The value of PI is |PI|.

生成する必要がある

The value of PI is 3.14159.

おそらく代替手段は:py:const:、実際の値を置き換えるのではなく、値の定義へのリンクを挿入する python ドメイン ディレクティブです。

于 2014-04-25T16:17:07.080 に答える