Skip to main content
 首页 » 编程设计

python之如何在 sphinx autodoc 中有选择地隐藏模块文档字符串

2025年02月15日21langtianya

在 autodoc 中,我知道您可以隐藏所有 模块的文档字符串,如下所述: Exclude module docstring in autodoc

但是有没有一种方法可以对某些模块而不是其他模块执行此操作,可能会将一些参数传递给 automodule?换句话说,对于给定的模块,我希望有时包含文档字符串,有时跳过它。如果我这样做:

.. automodule:: foo 
   :members: foo, foo.bar 

Sphinx 为 foo 和 foo.bar 生成文档字符串。然而,做

.. automodule:: foo 
   :members: foo.bar 

不会隐藏模块文档字符串。

请您参考如下方法:

要隐藏模块的文档字符串,您可以使用指令的相应普通 py 域版本:py:module或 py:currentmodule .前者是您记录模块的主要位置,并且应该只出现一次。后者适用于您需要相同名称解析属性的其他地方,但没有将其作为模块的官方文档点。

所有 autodoc 域指令都将遵守由常规 py 域指令设置的命名范围。来自文档:

Note

Just as py:class respects the current py:module, autoclass will also do so. Likewise, automethod will respect the current py:class.