私人成员的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 (将#修改为@)

相关问答

错误1:Request method ‘DELETE‘ not supported 错误还原:...
错误1:启动docker镜像时报错:Error response from daemon:...
错误1:private field ‘xxx‘ is never assigned 按Alt...
报错如下,通过源不能下载,最后警告pip需升级版本 Requirem...