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

要在Sphinx生成的HTML文档中删除特定的术语,如“模块”和“词”,你可以使用Sphinx的`exclude_patterns`配置选项来排除不需要的文件或文件夹。以下是一个详细的步骤说明,以及代码示例:

1. 首先,打开你的项目的根目录下的 `docs/source` 文件夹。
2. 在这个文件夹中,创建一个名为 `conf.py` 的文件(如果还没有的话)。
3. 在 `conf.py` 文件中,添加以下配置选项:

```python
# conf.py

# 设置不需要生成文档的文件或文件夹
exclude_patterns = ['module', 'term']

# 如果你的术语出现在模块和词的名称中,你也可以使用正则表达式来排除它们。例如,如果你想排除所有以 "module" 或 "term" 开头的文件,可以这样写:
exclude_patterns = [r'^(module|term).*']
```

4. 保存 `conf.py` 文件。

现在当你运行 `make html` 命令生成Sphinx文档时,所有以 "module" 或 "term" 开头的文件或文件夹都不会被包含在生成的HTML文件中。

注意:在使用正则表达式时,你需要确保你的路径是正确的,并且你使用的操作系统和Python环境支持正则表达式。

  • 3
    点赞
  • 7
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

潮易

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值