Sphinxでは、__getattr__で提供される文書属性

Question

PythonのSphinxでは、__getattr__のおかげで利用可能な属性をどのように文書化できますか？

私は、セクション名に一致する属性、つまりconfig_manager.<section_name>を使用して設定の任意のセクションにアクセスできるような設定マネージャのインスタンスを持っています。

.. autoclass:: ConfigManager 
    :members: 
    :var .<section_name>: Access any section of the configuration by its name. 

が、これもこの種を提供するものの、ドキュメントにあまりにも目立つように表示されません。今、私は.rstファイル内でこれを文書化する（ただし、コードに好む）このようなものとするために

アクセスはそのクラスの主な目的の1つです。

Answer 1

あなたはこのように、.. attribute::ディレクティブを使用することができます。

.. autoclass:: ConfigManager 
    :members: 

    .. attribute:: <section_name> 

     Access any section of the configuration by its name. 

属性は、メソッドの前に現れる（およびメソッドのように提示）出力になります。