用于记录特征的autodoc扩展

trait_documenter的Python项目详细描述


https://travis-ci.org/enthought/trait-documenter.svg?branch=masterhttp://codecov.io/github/enthought/trait-documenter/coverage.svg?branch=masterhttps://readthedocs.org/projects/trait-documenter/badge/?version=latest

trait documenter是一个autodoc扩展,允许trait定义 在狮身人面像中正确地呈现。

安装

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

该包需要sphinxtraitsastor的最新版本才能正常工作。

用法

将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.

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
如何将图像写入文件–Java ImageIO   spring无法获取连接,数据源无效:“java.sql.SQLException:找不到适合数据源的驱动程序”   java错误,请在hs_err_pidXXX中输入信息。JVM崩溃时的日志文件   java任何人在resteasy中都会遇到不可用的根路径吗   java JPA元模型和实体类   java在jhipster应用程序上找不到symbol:class SparkReporter   java向前看下一个地图条目   java单个泛型参数同时接受两种不同的类型   java无法通过KAFKA api连接到EventHub   Java swing JPanel将数据从Textarea保存到字符串变量   java“downloadmavenplugin”可下载多个文件并重新定位输出目录   java单例类与静态方法和字段?   java多线程Spring事务   没有片段的java滑动菜单   java在swing中,是否可以在paintComponent()中找到JPanel的宽度和高度属性?   使用ProcessBuilder使用交互式IO运行java C程序   javajavax。imageio。IIOException:无法在Tomcat 9、OpenJDK 11和Geoserver中创建ImageInputStream   java对整数使用哈希集