Как использовать атрибут __doc__ атрибутов класса не-метода в autodoc - PullRequest
Новая
       17

Как использовать атрибут __doc__ атрибутов класса не-метода в autodoc

0 голосов
/ 03 апреля 2019

Я хотел бы автоматически вставлять строки документации некоторых атрибутов класса в мою документацию вместо представления, которое обычно помещается в вывод.

У меня есть класс, 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 ...>

Мне бы хотелось, чтобы что-то выглядело так:

класс тест

Это класс.

ATTRIBUTE

Это моя документация

Единственный способ сделать это до сих пор - это явно скопировать строки документации моих атрибутов в документацию: 

.. autoclass:: Test

   .. attribute:: ATTRIBUTE

      This is my docstring

Я чувствую, что это избыточно, подвержено ошибкам и расточительно. Есть ли способ включить строку документации указанного атрибута в документацию, используя autodoc?

...