如何使用make htmlhelp 命令生成 HTML 帮助文件时,可以自动生成 .hhk 文件
时间: 2024-04-11 10:26:18 浏览: 27
要生成 HTML 帮助文件时自动创建 .hhk 文件,你可以在使用 `make htmlhelp` 命令时使用以下方法:
1. 确保你的项目中有一个 `conf.py` 文件,该文件是Sphinx项目的配置文件。
2. 打开 `conf.py` 文件,并添加以下代码:
```python
htmlhelp_basename = 'your_project_name' # 替换为你的项目名称
def setup(app):
import os
from sphinx.builders.html import StandaloneHTMLBuilder
def generate_hhk(app):
hhk_file = os.path.join(app.builder.outdir, f'{app.builder.basename}.hhk')
with open(hhk_file, 'w', encoding='utf-8') as f:
f.write('<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">\n')
f.write('<HTML><HEAD><meta charset="utf-8">\n')
f.write('<meta name="GENERATOR" content="Microsoft® HTML Help Workshop 4.1">\n')
f.write(f'<title>{app.builder.basename}</title>\n')
f.write('</HEAD><BODY>\n')
f.write(f'<OBJECT type="text/site properties">\n')
f.write(' <param name="Name" value="Python Documentation">\n')
f.write(f' <param name="Local" value="{app.builder.basename}.hhp">\n')
f.write(' <param name="ImageType" value="Folder">\n')
f.write('</OBJECT>\n')
f.write('</BODY></HTML>\n')
StandaloneHTMLBuilder.supported_image_types = [
'image/gif', 'image/png', 'image/jpeg', 'image/svg+xml'
]
StandaloneHTMLBuilder.generate_hhk = generate_hhk
# 其他配置代码...
# 在文件末尾添加以下代码
def setup(app):
app.connect('builder-inited', generate_hhk)
```
3. 保存 `conf.py` 文件,并在命令行中运行 `make htmlhelp` 命令。这将生成 HTML 帮助文件和一个名为 `your_project_name.hhk` 的文件。
请注意,上述代码中的 `your_project_name` 应替换为你的项目名称。你还可以修改生成的 `.hhk` 文件的内容,以满足你的特定需求。