SphinxのPythonドメインで相互参照の役割を使用する

Pythonドメインの相互参照役割の使用を理解できません。具体的にはです。py：const：誰かがより明確な説明とその使用例を提供できますか？SphinxのPythonドメインで相互参照の役割を使用する

例えば、私は次のディレクティブが含まれていmodule.rstファイルがあります：PY：：CONST：SUCCESSはモジュールCommonSymbolsで定義された変数であるSUCCESS、私が期待していたドキュメントから

.. default-role:: any 
.. automodule:: CommonSymbols 
     :members: 

:py:const: Success 
:py:mod: CommonSymbols

をCommonSymbolsでSUCCESSの定義へのリンクを生成します。同様に、py：mod：CommonSymbolsが発生したとき、CommonSymbolsモジュールへのリンクを期待していました。

代わりに、私は表示されたHTML内の2つの役割について次のような出力が得られます。

:py:const: Success :py:mod: CommonSymbols

これは全く役に立たないと私はこれらの役割は、実際にどのように機能するかを尋ねた理由です。 :py:const:ための相互参照Pythonオブジェクトの下のドキュメントから

出典

2017-07-02 Jonathan

構文が間違っています。相互参照のターゲットは、 ''：py：mod： 'CommonSymbols''のようにバッククォートで囲む必要があります。 – mzjn

：

このマークアップで囲まれた名前は、モジュール名および/またはクラス名を含むことができます。例えば、

:py:func:`filter`

は、現在のモジュール内のフィルタ、またはその名前の組み込み関数という名前の関数を参照することができます。

試してみてください。

:py:const:`CONSTANT`

出典

2017-07-02 04:02:51

私の編集した質問から分かるように、このマークアップは何も役に立たないようです。 – Jonathan

あなたの例でブロックをミキシングしています。私が提供した構文は、スタンドアローンのPythonの 'constant'オブジェクトへの参照を定義するときに機能します。あなたの編集された質問については、あなたの 'conf.py'に' autodoc'拡張子を含めてから、あなたのreSTインデントのフィールドに追加する必要があります。フィールドに定数がサポートされているかどうかは分かりません。 http://www.sphinx-doc.org/en/stable/ext/autodoc.htmlを参照してください。 –

SphinxのPythonドメインで相互参照の役割を使用する

答えて

関連する問題