如何在Autodoc中使用非方法类属性的__doc__属性

时间:2019-04-03 20:33:12

标签: python python-sphinx autodoc

我想将某些类属性的文档字符串自动插入文档中,而不是通常放置在输出中的表示形式。

我有一个类Test,看起来像这样:

class Instance:
    def __init__(self, ds):
        self.__doc__ = ds

class Test:
    """
    This is a class.
    """

    ATTRIBUTE = Instance('This is my docstring')

我的第一个文件如下:

.. autoclass:: Test
   :members:

当我生成文档时,它看起来像这样:

  

测试

     

这是一堂课。

     

ATTRIBUTE = <实例对象位于0x ...>

我想拥有一些最终看起来像这样的东西:

  

测试

     

这是一堂课。

     

属性

     

这是我的文档字符串

到目前为止,我唯一能够做到这一点的方法是,将属性的文档字符串明确复制到文档中:

.. autoclass:: Test

   .. attribute:: ATTRIBUTE

      This is my docstring

我觉得这是多余的,容易出错并且很浪费。有没有办法使用autodoc在文档中包含引用属性的docstring?

0 个答案:

没有答案