微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

如何使用Sphinx在自动模块中指定__all__的部分成员

如何解决如何使用Sphinx在自动模块中指定__all__的部分成员

是否有一种方法可以输出部分成员(太多类),而不是package.module中 all 中的所有成员,我不想手动指定这些成员,因为成员太多且不方便维护。

.. automodule:: package.module
     :members: 

我想到了两种方法

  1. 变量替换。在conf.py中定义一个包含所有指定成员的列表(仅命名为temp_all),并在automodule中将其替换,如下所示:

    .. automodule:: package.module
         :members: temp_all
    

    我尝试使用config.py中定义的rst_prolog,但似乎不适用于自动模块。

    temp_all = ','.join(package.module.temp_all)
    
    rst_epilog = '.. |temp_all| replace:: %s' % temp_all
    
  2. 直接使用automodule中的package.module.temp_all指定部分成员:

    .. automodule:: package.module
         :members: package.module.temp_all
    

我不知道这样做的方式。感谢您的帮助!

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。