使用Sphinx在HTML中创建上下文相关的帮助文件

2024-06-16 10:37:48 发布

您现在位置:Python中文网/ 问答频道 /正文

我目前使用AsciiDoc来记录我的软件项目,因为它支持PDF和HTML帮助生成。我目前正在通过Cygwin运行它,以便a2x工具链能够正常工作。这对我来说很好,但在其他Windows计算机上安装起来很麻烦。我一直在寻找替代方法,最近又重访了斯芬克斯。注意到它现在生成HTML帮助文件,我尝试了一下,在我执行的小测试中,它似乎工作得很好

我的问题是,是否有办法在文本中指定上下文相关帮助的映射id,以便我的Windows程序可以调用适当的帮助API,并将文件启动并打开到所需位置

在ascidoc中,我使用pass::[<?dbhh topicname="_about" topicid="801"?>]。通过使用这些构造,将生成context.halias.h以及其他HTML帮助文件(context sensitive help information


Tags: 工具项目方法软件pdfwindowshtml记录