如何修剪狮身人面像自动模块成员的前导路径

Question

使用自动模块时是否有指令或方法来修剪导入路径的一部分？

例如，当使用automodule指令时，我有类似的东西：

.. automodule:: super.cool.thing.my_module
    :members:
    :undoc-members:

这可以很好地生成包含模块中功能的文档，但会显示完整路径。如果我将add_module_names设置为False，它将完全删除所有路径信息，并仅保留函数名称。如果您在多个模块中具有类似的命名函数，这可能会有点混乱。因此，我希望这些函数只显示一部分导入路径。所以不要这样：

super.cool.thing.my_module.my_function(a, b, c)

我只想：

my_module.my_function(a, b, c)

使用add_module_names指令只显示：

my_function(a, b, c)

在我的用例中，这是不可取的。在此先感谢您的帮助。

Answer 1

这是通过使用config.py文件中的sys.path.insert（）来完成的。

从上面的示例中注册路径：

.. automodule:: my_module
    :members:
    :undoc-members:

在Sphinx指令中，您修剪上面描述的路径：

my_module.my_function(a, b, c)

现在将生成具有所需缩短函数名称的文档：

list