栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 面试经验 > 面试问答

如何使用Sphinx的自动文档来记录类的__init __(self)方法?

面试问答 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

如何使用Sphinx的自动文档来记录类的__init __(self)方法?

这是三种选择:

  1. 为了确保

    __init__()
    始终记录
    autodoc-skip-member
    在文档中,可以在conf.py中使用。像这样:

    def skip(app, what, name, obj, would_skip, options):if name == "__init__":    return Falsereturn would_skip

    def setup(app):
    app.connect(“autodoc-skip-member”, skip)

这明确定义了

__init__
不被跳过(默认情况下为跳过)。仅一次指定此配置,并且.rst源中的每个类都不需要任何其他标记。

  1. special-members
    选项已在Sphinx 1.1中添加。它使
    __special__
    autodoc记录“特殊”成员(名称如的成员)。

从Sphinx 1.2开始,此选项接受参数,这使其比以前更有用。

  1. 用途

    automethod

    .. autoclass:: MyClass

    :members:

    .. automethod:: init

这必须为每个类添加(不能与一起使用

automodule
,如对此答案的第一个修订版的注释中指出的那样)。



转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/610887.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号