python - 从 Sphinx 文档中删除单词 "module"

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 生成的 reST 文件添加了模板。 .

使用 --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 .