37

Python コンポーネントと JavaScript コンポーネントを含むライブラリを文書化しています。全体的なユーザー ドキュメントと Python API ドキュメントは、Sphinx で処理された reStructuredText にあります。JavaScript API は jsdoc にあり、jsdoc-toolkit で処理されます。主な出力形式は HTML です。reST、Sphinx、jsdoc は初めてです。

生成されたすべての HTML ページが単一のディレクトリ ツリーにダンプされるように、ビルド システムをセットアップしました。ここで、メイン ページ (reST から生成) に、生成された Javascript ドキュメントへのリンクを挿入する必要があります。ドキュメントは異なるインストールの異なる場所にある可能性があるため、これは相対リンクである必要があります。reST は完全な URL を自動的に解析しますが、相対リンクを挿入する方法がわかりません。:ref::doc:のような構造は、ターゲットが reST であることを期待しているため、役に立たないようです。

何か案は?

4

1 に答える 1

50

理解した。以下は、ドキュメントへの相対参照を挿入しますjs/index.html

`Javascript API <js/index.html>`_
于 2010-09-02T19:29:15.910 に答える