2

私がプロジェクトを持っているとしましょう。そこでは(どこかで)次の関数が文書化されています:

.. exmpl:cfunction:: ExMpl* ExMplSet( int flags, int size, ExStorage* storage )

そのプロジェクトのドキュメントの他の場所に、次のような参照があります。

:exmpl:cfunc:`ExMplSet`

すべてが合法であるように思われ、ドキュメントにはこの使用例が他にもありますが、出力としてSphinxは警告を出します。

~/some_folder/some_file:320: WARNING: unresolved reference: u'ExMplSet' - u'cfunc'

あるべきリンクはなく、100以上の警告(プロジェクト全体)はそれほど良くありません。

これらの正確な例はもちろん構成されています。私が求めているのは、答えを探すためのヒントです。

4

1 に答える 1

0

私はそれが別々の行に分割されることを期待します。一方をターゲットにし、もう一方を定義します。

.. exmpl:cfunction:: ExMplSet

ExMpl* ExMplSet( int flags, int size, ExStorage* storage )

もう1つのオプション(現在これを確認できません)は、「exmpl:」の前にコロンがないことです。

于 2012-12-11T07:44:19.187 に答える