Python 如何将特定模块的'add_module_names'更改为'False'？

如何将特定模块的

添加模块名称

更改为

False

我的结构如下：

src/
/吴福
一些_file.py
/酒吧
some_other_file.py

我希望所有函数都包含

。。autofunction:：

从

\u foo

模块隐藏模块名称，而条形模块的所有功能都显示名称

是否有办法按模块执行此配置，或者甚至为每个功能单独执行此配置？

布尔值是

conf.py

中的常规配置设置。它反映了项目范围内使用对象呈现模块名称的选择，不能为特定模块更改。可以实现规则的例外情况，但解决方案需要额外编写

在本例中，解决方案是使用域指令显式声明所需的成员。这使您可以指定签名和签名。缺点是您将不会使用，因此您将无法从Python源代码中自动提取docstring。取决于您决定放置

的位置。。py:function:：

可能需要在特定指令中使用和-用法如示例所示

请注意，最后一个示例仍然需要一个前导的

点，否则Sphinx将按照

add\u module\u names=True

的指定在完全限定名之前加上前缀

两个简单的示例文件，

bar.some\u other\u file.py

：

“”“bar.some\u other\u文件模块docstring。”“”
定义一些其他函数（）：
“”“其他函数文档字符串。”“”

和

\u foo.some\u file.py

：

“\u foo.some\u文件模块docstring。”“”
定义某个函数（参数\示例=“字符串”）：
“”“某些函数文档字符串。”“”

使用以下

.rst

比较两种情况：

_foo costum module name
-----------------------

.. automodule:: _foo.some_file
    :members:
    :undoc-members:
    :exclude-members: some_function

    .. autofunction:: some_function

    .. py:function:: .some_function(argument_example="a string")
        :noindex:

        Example without any module name.

bar costum module name
----------------------

.. automodule:: bar.some_other_file
    :members:
    :undoc-members:
    :exclude-members: some_other_function

    .. autofunction:: some_other_function

    .. py:function:: bar.some_other_file.some_function(argument_example="a string")
        :noindex:

        Example with a different qualified name.

给出以下结果：

---

您在.rst中尝试了什么？我们在金字塔文档中这样做。有关

提取http\u基本凭据的信息，请参见和。模块名称显示为页面标题，但可以删除。您需要将函数名缩进模块名下，如示例所示。@StevePiercy您的解决方案。
True
值的问题是Sphinx将自动在任何地方前置-问题是在该场景中是否出现异常。我像你一样写我的
.rst
，因为它可以更好地控制名称的呈现方式。您好，我能得到一些关于答案的反馈吗？