Sphinx autodoc および napoleon 拡張機能を使用して、プロジェクト ( Qtools ) のドキュメントを生成しています。これは私のローカルマシンでうまく機能します。Sphinx 3.1.2 (またはそれ以降) を使用しています。ただし、Read the Docs (RTD) でドキュメントをビルドすると、ドキュメントのソースを形成する reStructuredText ファイルに直接追加されたテキストのみが処理されます。autodoc によって取り込まれるはずの docstring は、 RTD によって生成された HTML ドキュメントには表示されません。たとえば、docs\source\section2_rsdoc.rst次のようなものがあります。
Response spectra
================
The response spectrum class
---------------------------
.. autoclass:: qtools.ResponseSpectrum
:members:
Response spectrum creation
--------------------------
.. autofunction:: qtools.calcrs
.. autofunction:: qtools.calcrs_cmp
.. autofunction:: qtools.loadrs
See also :func:`qtools.convert2rs` (converts a power spectrum into a response spectrum).
これにより、次の結果が得られます。
応答スペクトル
応答スペクトル クラス
応答スペクトルの作成
qtools.convert2rs(パワー スペクトルを応答スペクトルに変換する)も参照してください。
つまり、すべてのディレクティブは明らかに無視され、他の機能へのハイパーリンクは追加されません。このようないくつかの基本的なガイダンス文書を調べましたが、何が間違っているのかわかりません。RTD は、エラーや警告なしでドキュメントをビルドします。RTD の詳細設定には次のものがあります。
- ドキュメントタイプ: Sphinx HTML
- 要件ファイル: requirements.txt
- Python インタープリター: CPython 3.x
- プロジェクトのインストール: いいえ
- システム パッケージを使用する: いいえ
- Python 構成ファイル: 空白
- PDF ビルドを有効にする: いいえ
- EPUB ビルドを有効にする: いいえ
他の設定には触れていません。
では、 conf.py15 行目の次のバリエーションを試しました: sys.path.insert(0, os.path.abspath('.'))、sys.path.insert(0, os.path.abspath('../..'))および現在のsys.path.insert(0, os.path.abspath('../../..')). それらのどれも違いはありませんでした。
どんな助けにも感謝します！