75987


Sphinxにおいて、docstirngを用いてソースコードからモジュールドキュメントを生成しています。

その際、sphinx-apidocコマンドを使用します。  
例えば以下のように入力します。

[code]

    sphinx-apidoc -f -P -o ./_documents_/Development/source/_root_source_ ./
    
[/code]

このコマンドで生成された.rstファイルでは、モジュール名を除き一律に以下のような内容となります。

[code]

    class\_API module
    =================
    
    .. automodule:: class_API
       :members:
       :undoc-members:
       :show-inheritance:
       :private-members:
    
[/code]

__init__だけは特別に記載したい場合、以下の記述が必要ですが、sphinx-apidocコマンドで対応することはできるでしょうか？

[code]

       :special-members: __init__
    
[/code]


CC BY-SA 4.0
2021-05-20T05:48:57.083
75973
2021-05-20T20:32:17.280
32891
question
python3 sphinx
Sphinxのsphinx-apidocコマンドによるソースドキュメント自動生成で、__init__関数を表示させる方法は？


sphinx-apidocコマンドでは指定出来ませんが、 `conf.py` に `autodoc_default_options`
を指定する方法があります。

[code]

    autodoc_default_options = {
        'special-members': '__init__',
    }
    
[/code]

公式ドキュメント:  
<https://www.sphinx-doc.org/ja/master/usage/extensions/autodoc.html#confval-
autodoc_default_options>


CC BY-SA 4.0
2021-05-20T20:32:17.280
75987
2021-05-20T20:32:17.280
806
75973
answer