trait_documenter 1.1.0

安装

开发版本可在 https://github.com/enthought/trait-documenter 找到。

该包需要最新版本的 sphinx、traits 和 astor 才能正常工作。

用法

将 trait-documenter 添加到您的 conf.py 中的扩展变量

extensions.append('trait_documenter')

示例

具有文档字符串的类特质

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.