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

私人成员的python-sphinx自动摘要

如何解决私人成员的python-sphinx自动摘要

我正在尝试使用python sphinx sphinx.ext.autosummary扩展名,但是有一个问题,即它不会在生成的表中为私有成员创建条目。我的意思通常是指模块,函数等以下划线开头的名称

我知道我可以将私人成员标记为非私人,但我不想这样做。

我也尝试了自动文档选项autodoc_default_options,但是设置'private-members': True并没有帮助。我可以更改自动摘要模块模板,并在其中插入类似的内容

.. automodule:: {{ fullname }}
   :members:
   :undoc-members:
   :private-members:

此后,它包括私有成员文档,但是生成摘要表仅包括公共成员。

autosummary指令不接受:private-members:选项。

如何强制它也为私有模块和其他成员创建摘要

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