Sphinx を使用して、現在十分に文書化されていない大規模なプロジェクトを文書化したいと考えています。sphinx-apidoc特に、コードをドキュメント化する際に、コードからドキュメントを生成するために使用したいと考えています。
ただし、プロジェクトの使用方法などに関するチュートリアルのページもいくつか用意したいのですが、呼び出すsphinx-apidocとドキュメント全体が一度に生成されるようです。
私の質問は次のとおりです。手動で作成するチュートリアル ページを作成し、同時にコード内のドキュメントを更新できる正しいワークフローは何ですか? 手動で作成したチュートリアル ページ (たとえば に含まれているものindex.txt) を更新して実行するsphinx-apidocと、ドキュメント全体が一度に生成されるため、それらが失われることに注意してください。
一般に、ドキュメントの作成を進める方法に関するガイドラインはありますか?
注:基本的な手順では、すべてのコード ドキュメントが既に配置されていることを前提としており、ドキュメントの作成を進めても更新は行われないため、不都合が生じます。少なくともこれは私が解決する必要があるものです。