Я хочу автоматически сгенерировать документацию для моего кода из строк документации.У меня есть базовый класс, предназначенный для хранения некоторых данных:
class DataHolder:
"""
Class to hold some data
Attributes:
batch: Run without GUI
debug (bool): Show debug messages
"""
batch: bool = False
debug: bool = False
name: str = 'default'
"""Object name"""
version: int = 0
"""int: Object version"""
Мой rst файл:
DataHolder
==========
.. autoclass:: data_holder.DataHolder
:members:
Я задокументировал каждый атрибут по-своему, чтобы показать разницу, здесьэто вывод:
Похоже, что Sphinx не может связать секцию Attributes с реальными атрибутами, поэтому он не может отображать их значение по умолчанию.
Последний вывод, который я хотел бы получить, - это результат для поля version с строкой документации, определенной для batch.Я хочу отобразить имя атрибута со значением и типом по умолчанию, но взятых из аннотаций типов.Похоже, что Sphinx игнорирует аннотации типов в этом случае.
Мои расширения сфинкса:
extensions = [
'sphinx.ext.viewcode',
'sphinx.ext.autodoc',
'sphinxcontrib.napoleon',
]
Что я могу сделать, чтобы добиться такого поведения?Я не могу найти хороших примеров для такого варианта использования.