タグ付けされた質問 「toctree」

6
sphinxは、ルートドキュメントの下のディレクトリにないドキュメントにリンクできますか?
私はSphinxを使用してPython以外のプロジェクトを文書化しています。./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 <../../modules/module1/docs/module1> ただし、次のエラーメッセージが表示されます。 警告:toctreeには、存在しないドキュメントu'modules / module1 / docs / module1 'への参照が含まれています ../どういうわけかドキュメントパスで使用することはできませんか? 更新:conf.pyの場所を追加しました 更新:以下のインクルードトリックを除いて、これはまだ(2019)不可能です。前進し続ける未解決の問題があります:https://github.com/sphinx-doc/sphinx/issues/701
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.