Я использую sphinx-apidoc
и sphinx-build
с scipy-sphinx-theme для автоматического создания документации по моим проектам из моих numpy-style
строк документации.
Я бы хотел, чтобы sphinxотформатировать мои атрибуты класса в таблице вместо списка описания, так же как autosummary создает хорошую таблицу методов, так как я считаю это пустой тратой пространства и разрушает обзор атрибутов класса, если их много, как вы можете видеть вследующее изображение.
![enter image description here](https://i.stack.imgur.com/Exfln.png)
Мои документы __init__
выглядят примерно так.Поскольку атрибуты определены во время выполнения, мне нужно явно задокументировать их в разделе Attributes
.Но по умолчанию они помещаются в список описания вместо таблицы.
.. rubric:: Methods
.. autoautosummary:: htmdmol.molecule.Molecule
:methods:
.. rubric:: Attributes
Attributes
----------
numAtoms : int
Number of atoms in the Molecule
numFrames : int
Number of conformers / simulation frames in the Molecule
Я пытался найти шаблоны, которые генерируют элементы <dd> <dl>
в списке атрибутов, но безуспешно.Если бы кто-нибудь мог помочь мне с тем, как сделать раздел Attributes
таким же, как раздел Methods
, я был бы вне себя от радости.