python - モジュール名を表示するSphinx自動モジュール？

Question

私は.. automodule:: mypath.mymodule自分のドキュメントで使用しました。メンバー向けの他の情報がないプレーンモジュールのdocstringが必要でした。モジュールのdocstringが表示されますが、モジュールの名前や特別な段落の書式は示されていません。

実際のモジュールの名前を含め、通常のテキストと区別するためにその特定の段落を強調する標準的な方法はありますか？

Answer 1

「標準的な」方法は、モジュール名で見出しを追加することだと思います。

mypath.mymodule
===============

.. automodule:: mypath.mymodule

一部のパッケージの例（「ソースの表示」をクリックしてreSTマークアップを表示）：

• セロリ：http ：//docs.celeryproject.org/en/latest/reference/celery.events.html
• PyMongo：http ://api.mongodb.org/python/current/api/bson/index.html
• matplotlib： http: //matplotlib.org/api/dates_api.html