Python以外のプロジェクトを文書化するためにSphinxを使用しています。各サブモジュールに./doc
フォルダーを配布し、そのモジュールを文書化するための submodule_name.rst
ファイルを含めます。次に、これらのファイルをマスター階層に取り込み、デザイン全体の仕様を作成します。
つまり:
Project docs spec project_spec.rst conf.py modules module1 docs module1.rst src module2 docs module2.rst src
次のようにマスターproject_spec.rst
ドキュメントtoctreeにファイルを含めようとしました:
.. toctree :::numbered :: maxdepth:2 Module 1&lt ; ../../ modules / module1 / docs / module1>
ただし、次のエラーメッセージが表示されます:
警告:toctreeには、存在しないドキュメントu "modules / module1 / docs / module1"
<への参照が含まれています/blockquote>ドキュメントパスで
../
を使用することはできませんか?更新:conf.pyの場所を追加しました
更新:以下のインクルードトリックを除いて、これはまだ(2019)不可能です。前進し続ける未解決の問題があります: https://github.com/sphinx- doc / sphinx / issues / 701