用于记录特征的autodoc扩展
trait_documenter的Python项目详细描述
trait documenter是一个autodoc扩展,允许trait定义 在狮身人面像中正确地呈现。
用法
将trait documenter添加到conf.py中的extensions变量:
extensions.append('trait_documenter')
警告
将traitdocenter与traitsdoc包结合使用 不建议。
示例
带有docstring的类特征:
from traits.api import HasTraits, Float class MyClass(HasTraits): #: A float number. number = Float(2.0)
将呈现为:
.. py:attribute:: number :annotation: = Float(2.0) A float number.