sphinx.ext.apidoc
プロジェクトの docstring からドキュメントを抽出する.rst ファイルのセットを構築したプロジェクトがあります。
これらのファイルは次のようになります。
Submodules
----------
.. toctree::
mymodule.submodule
Module contents
---------------
.. automodule:: mymodule
:members:
:undoc-members:
:show-inheritance:
make html
私のコンピューターでドキュメントを適切にビルドしますが、conf.py
ファイルを編集してプロジェクトを python システム パスに追加する必要があります。
ただし、readthedocs でドキュメントを作成しようとすると、autodoc が参照されているモジュールを見つけることができません。これは、autodoc がプロジェクト モジュールを適切に見つけるために、python システム パスに追加する必要があるパスがわからないためです。
ローカル環境で autodoc を使用して .rst ファイルを事前にビルドして、autodoc への呼び出しが含まれないようにし、それらを readthedocs にアップロードして、実行する必要がないようにすることができるかどうか疑問に思っていました。そこのautodoc拡張機能。
これを行う方法がない場合、その問題を解決する適切な方法は何でしょうか?