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

Question

使用Automodule时是否有指令或方法可以从功能中修剪一部分导入路径？

例如，使用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((来完成的。

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

sys.path.insert(0, os.path.abspath('/some/path/super/cool/thing'))

在狮身人面像指令中，您修剪上述已经描述的路径：

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

现在，这将产生所需缩短功能名称的文档：

my_module.my_function(a, b, c)