重命名自动摘要树项

Question

我决定使用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'

有一种方法可以重命名导航栏中的条目，最好是在index.rst**?**中，如果完成了任务，我也愿意考虑将方法从autosummary更改为其他系统。

我还为名为_templates/autosummary/module.rst的模块使用了自定义模板。其内容如下：

{{ fullname }}
{{ underline }}

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

Answer 1

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

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

然后将module.long_sub.etc更改为long_sub.etc in index.rst。您可以在根文件夹(例如D:/abs/path/to/module/long_sub)中插入目录，以便有更短的导入。