从 Sphinx 文档中删除“模块”一词

Question

使用Sphinx记录我的 Python 项目。我想删除每个 python 文件名称后面的“模块”一词（在导航栏、目录、页面标题等中）。

例如详细信息：

该项目由 2 个文件utils.py和main.py.

在我的index.rst文件中，我使用：

.. toctree::
   :maxdepth: 2

   utils
   main

将两个文件作为“模块”导入。docs/然后从文件夹中调用：

sphinx-apidoc -f -o ./source/ .. 
make html

生成静态站点。在该站点中，每个文件名后面都带有“模块”一词，我想将其删除。

Answer 1

Sphinx 2.2 为由sphinx-apidoc.

使用该--templatedir选项设置包含module.rst_t,package.rst_t和toc.rst_t文件的目录的路径。可以从site-packages/sphinx/templates/apidoc.

然后，在package.rst_t替换

{{- [submodule, "module"] | join(" ") | e | heading(2) }}

和

{{- submodule | e | heading(2) }}

重复module.rst_t。