36

sphinxのオートモジュール（https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html）を使用する場合、

.rstファイルに書き込むだけです。

.. automodule:: my_module
    :members:

my_moduleは正常に文書化されていますが、my_module.inner_module0やmy_module.inner_module1などの内部モジュールは見つかりません。__all__変数以外に__init__。pyファイルで指定する必要があるものはありますか？

また、私は知っていsphinx-apidocます。しかし、そのコマンドは文書化が多すぎます（文書化されていないものを含むすべての関数/フォルダーを公開します）。

4

2 に答える 2

41

automoduleディレクティブにパッケージ名を付けて、ディレクトリに再帰させ、各 Python モジュールを文書化したいようです。それはまだサポートされていません。文書化する各モジュールの完全なドット付きモジュール名を指定する必要があります。

たとえば、次のディレクトリ構造があるとします (Python ドキュメントから)。.. automodule:: sound.formatsディレクトリ内のすべてのモジュールを指定して文書化することはできません。automoduleモジュールごとにコマンドを指定する必要があります: .. automodule:: sound.formats.waveread、 .. automodule:: sound.formats.wavewriteなど。

sound/                          Top-level package
      __init__.py               Initialize the sound package
      formats/                  Subpackage for file format conversions
              __init__.py
              wavread.py
              wavwrite.py
              aiffread.py
              aiffwrite.py
              auread.py
              auwrite.py
              ...
      effects/                  Subpackage for sound effects
              __init__.py
              echo.py
              surround.py
              reverse.py
              ...
于 2012-07-19T19:49:58.107 に答える