4

私はいくつかのpythonプロジェクトのドキュメントに取り組んでいます。2 つ以上のドキュメントの接続に問題があります - 私は 3 つの Sphinx プロジェクト (ドキュメント) を持っており、詳細なドキュメントへのリンクを一般的なドキュメントに追加できるようにしたいと考えています。

私はそのようなプロジェクト構造を持っています:

project/
|     doc/                          # this is my general doc
|     |    source/                  # sphinx general doc .rst files are here
|     |     build/
|     |    _static/
|     |    _templates/
|     |    CVS/
|
|
|     forms/
|     |    doc/
|     |    |    source/             # sphinx forms doc .rst files are here
|     |    |     build/
|     |    |    _static/
|     |    |    _templates/
|     |    |    CVS/    
|     |     
|     |    src/                     # forms source .py files are here
|
|     tables/
|     |    doc/
|     |    |    source/             # sphinx tables doc .rst files are here
|     |    |     build/
|     |    |    _static/
|     |    |    _templates/
|     |    |    CVS/    
|     |     
|     |    src/                     # tables source .py files are here

Forms doc と Tables doc の両方に、ソース ファイルから生成されたドキュメントが含まれています。

.. automodule::ディレクティブ。

一般的なドキュメントに Forms および Tables ドキュメントへのリンクを作成するにはどうすればよいですか?

多分私は何かを再編成する必要がありますか？

私はすでにインタースフィンクスについて少し読んだことがありますが、これまでのところ、へのリンク方法のみを示す例を見つけました

次のように、sphinx プロジェクトの conf.py ファイルで URL を指定することによる Python 標準ライブラリ ドキュメント:

intersphinx_mapping = {'python': ('http://docs.python.org/3.2', None)}

標準ライブラリとは異なるものを使用してそのようなものを作成する方法がわかりません。

URLではなく相対パスでその場所を指定します- 何かアイデアはありますか?

4

1 に答える 1

3

intersphinx 構成内の場所 (例では 'http://docs.python.org/3.2') は、実際には、HTML によって作成された objects.inv という名前のファイルがあるディレクトリへの任意の URI またはパスにすることができます。ビルダーであり、名前とリンクのレジストリが含まれています。「../forms/_build/html」などを使用してみてください。

于 2012-10-08T01:21:10.803 に答える