Tensorflowとnumpydocでのintersphinxの使用方法を教えてください。

Question

ここでの主な質問は、TensorFlowの場合はobjects.invがある場合ですが、実際に使用する方法の例はいいと思います。例えば

、私は現在、以下のドキュメンテーション文字列を持っている：

""" 
Load the weights of a model stored in saver. 

Parameters 
---------- 
checkpoint_dir : str 
    The directory of checkpoints. 
sess : tf.Session 
    A Session to use to restore the parameters. 
saver : tf.train.Saver 
""" 

私は自動的にTensorFlowのドキュメントにオブジェクトをリンクする方法をintershinx使うのですか？

Answer 1

mzjn is right - ドキュメントがスフィンクスで生成されていない場合、見つけ出すファイルはobjects.invになりません。

しかし、自分でobjects.invを作成してTensorflowと一緒に行くことができます。 how-to instructionsと一緒に、この正確なことをさせるためにPythonパッケージを公開しました。簡単に：

1. 新しいテキストファイルを作成します。

2. スフィンクスヘッダーを追加します。それぞれがあなたがインベントリに含まれることを望むオブジェクトに対して

   # Sphinx inventory version 2
# Project: <project name>
# Version: <full version number>
# The remainder of this file is compressed using zlib.

3. は、データの行を追加します。

   {name} {domain}:{role} {priority} {relative uri} {displayname}

{name}は、通常、完全修飾オブジェクト名です。 create your own Sphinx domainでもかまいませんが、衝突の可能性がほとんどない場合は、{domain}としてpythonと適切なPython {role}（function、methodなど）を使用できます。 {priority}はほとんど常に1であるべきです。 {relative uri}は、intersphinx_mappingパラメータに含めるベースURIからの相対値で、conf.pyです。 {displayname}は通常、完全修飾オブジェクト名です。

4. ファイルをobjects.invにsphobjinvでエンコードします。

5. 便利でアクセスしやすい場所にアップロードします。

6. 設定のintersphinx：

   intersphinx_mapping = {'tensorflow' = ('uri/to/tensorflow/docs/base', 'uri/to/objects.inv')}

はそれを行う必要があります。ちょっと手間がかかり、自分でファイルを合成する必要がありますが、必要に応じてファイルを追加するだけであれば、それほど悪くはありません。