スフィンクスを使用してモジュールのドキュメントストリングから* .rstファイルを参照する方法

Question

rstフォーマットで少しチュートリアルを書いた。今apidocによって生成されたドキュメントのために、私が使用してドキュメント文字列にそのチュートリアルを参照したいと思います：my_tut.rstは私のスフィンクス・ドキュメント・ソース・フォルダの最上位ディレクトリにある

:any:`<my_tut>` 

。しかし、私はエラー

WARNING: 'any' reference target not found: my_tut 

追加情報取得：

をapidocの出力は、トップレベルのソースフォルダではなく、codeというサブフォルダにありません。

Answer 1

:doc:役割はmy_tut.rstへの相互参照を作成するために使用することができます。

:doc:`my_tut` 

リンク元とリンク先を別のフォルダにある場合は、考慮する必要があるという。ソース上のターゲット1つのレベルで、それは次のようになります。

:doc:`../my_tut` 

---

代替はすぐmy_tut.rstの関連する見出しの前にlabelを追加し、使用することを相互参照のターゲットとして、 。ラベル定義が.. _my_label:であれば、あなたはこのようにそれを参照します：

:any:`my_label` 

また:ref:`my_label`を使用することができます。