現在、ドキュメントが 3 つの場所に分散している Python プロジェクトがあります。Python ファイルの例、Sphinx ドキュメント (IPython ノートブックから生成されたものもあります)、IPython ノートブックがあります。このすべてのドキュメントを IPython ノートブックの 1 つのセットに統合することを検討しています。最終的には、すべてのドキュメントを 1 か所に移動し、1 つのツール (IPython ノートブック) を使用することで、ユーザーと開発者の両方の生活を楽にしたいと考えています。正直なところ、ドキュメントの保守に必要な時間を最小限に抑えることは、ここでは最優先事項です。すべての開発者は、空き時間に無料で作業しています。
IPython ノートブックに対する Sphinx の大きな利点の 1 つは、Sphinx が apidoc を使用してコードから API ドキュメントを自動的に生成できることです。ライブラリの python ファイルを走査し、ノートブックに表示する docstring を抽出するコードを書くことで、IPython ノートブックでこの動作を再現できるはずです (数学や画像、および docstring の関連セクションのレンダリングを含む)。 (パラメータ、戻り値、注意事項など))。私の質問は次のとおりです。そのようなツールは既に存在しますか? つまり、Python ディレクトリを歩き回り、docstring を抽出して IPython ノートブックに表示できるツールで、理想的にはきれいな HTML フォーマットを使用していますか?