Sphinxautodocを使用して、ソース内のドキュメント文字列から Python モジュールのドキュメントを生成しています。ディレクティブに a:synopsis:を含めることができることはわかっていますが、そのようなものは、すべてのドキュメントを docstring に入れるという を使用する目的を無効にします。automoduleautodoc
moduleだから私は次のようにファイルにディレクティブを追加しようとしました：
.. module:: MyModule
:platform: Unix, Windows
:synopsis: A simple module to provide frobnication functions.
しかし、重複したモジュールについて「SEVERE」警告が表示されます。これは、モジュールを宣言していて、autodocそれも宣言しているためです。さらに、このようにすると、ファイル名からautodocモジュール名を特定するのではなく、モジュール名を指定する必要があるという点で、使用の目的が損なわautodocれます (大したことではありませんが、モジュールの名前を変更することにした場合モジュール、ここでも変更する必要があります)。
moduleauthorこのディレクティブに似たもの、modulesynopsisまたはディレクティブとして単独で使用できることを望んsynopsisでいましたが、Sphinx はこれらのいずれも認識していないようです。
を使用するときにdocstringに概要を含めることが可能かどうかは誰にもわかりautodocませんか?