Python 重命名自动摘要目录树条目

我决定使用

autosummary

创建模块的文档。在

index.rst

中，我已经“导入”了所有需要文档的相关模块和子模块。模块按预期记录，但有一件事困扰着我。模块路径相当长，并且在文档旁边的目录树中看起来令人厌恶

index.rst

Documentation
*************

Documentation of things.

.. toctree::

.. autosummary::
   :toctree: _autosummary

   module
   module.submodule
   module.submodule.sub

   module.long_submodule.sub_1
   module.long_submodule.sub_2
   module.long_submodule.sub_3
   module.long_submodule.sub_4

conf.py

project = 'Name'
author = 'Me'
version = '0.7'

extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.fulltoc', 'sphinx.ext.autosummary']
templates_path = ['_templates']
autosummary_generate = True
master_doc = 'index'

<强>是否有重命名导航栏中条目的方法，最好是在<代码>索引> RST < /C> > <强>中，如果愿意完成任务，我也愿意考虑从<代码> AutoSuMoMy//C>到其他系统。

---

我还为名为

\u templates/autosummary/module.rst的模块使用了自定义模板。其内容如下:

{{ fullname }}
{{ underline }}

.. automodule:: {{ fullname }}
   :members:
   :undoc-members:
   :show-inheritance:

可以扩展
sys.path
来导入子模块，而无需引用父模块。在
conf.py
中：

import sys
sys.path.insert(0, 'D:/abs/path/to/module')

然后在
index.rst
中将
module.long\u sub.etc
更改为
long\u sub.etc
。可以在根文件夹中插入目录（例如，
D:/abs/path/to/module/long\u sub
）以进行更短的导入。
可以扩展
sys.path
以导入子模块，而无需参考父模块。在
conf.py
中：

import sys
sys.path.insert(0, 'D:/abs/path/to/module')

然后在
index.rst
中将
module.long\u sub.etc
更改为
long\u sub.etc
。可以在根文件夹中插入目录（例如，
D:/abs/path/to/module/long_sub
）以进行更短的导入