本文介绍了从Sphinx文档中删除"；模块&一词的处理方法，对大家解决问题具有一定的参考价值，需要的朋友们下面随着小编来一起学习吧！
问题描述
使用Sphinx记录我的Python项目。我希望删除每个python文件(在导航栏、目录、页面标题等中)名称后面的单词"模块"。
例如详细信息：
项目由utils.py和main.py两个文件组成。
在index.rst文件中，我使用：
.. toctree::
:maxdepth: 2
utils
main
将这两个文件作为"模块"导入。然后从docs/文件夹调用：
sphinx-apidoc -f -o ./source/ ..
make html
以生成静态站点。在该网站中，每个文件名后面都有"模块"一词，我想将其删除。
推荐答案
Sphinx2.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。
这篇关于从Sphinx文档中删除"；模块&一词的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持编程学习网！
本站部分内容来源互联网,如果有图片或者内容侵犯您的权益请联系我们删除！