使用 Sphinx 创建 HTML 格式的上下文相关帮助文件
我目前正在使用 AsciiDoc 来记录我的软件项目，因为它支持 PDF 和 HTML 帮助生成。我目前正在通过 Cygwin 运行它，以便 a2x 工具链 正常运行。这对我来说效果很好，但在其他 Windows 计算机上设置却很痛苦。我一直在寻找替代方法，最近重新审视了 Sphinx。注意到它现在可以生成 HTML 帮助文件，我尝试了一下，它似乎在我执行的小型测试中运行良好。
我的问题是，有没有办法在文本中指定上下文相关帮助的地图 ID，以便我的 Windows 程序可以调用正确的帮助 API，并且文件启动并打开到所需的位置？
在 AsciiDoc 中，我使用 pass::[]。通过使用这些构造，将生成 context.h 和 alias.h 以及其他 HTML 帮助文件 (上下文相关帮助信息）。
I am currently using AsciiDoc for documenting my software projects because it supports PDF and HTML help generation. I am currently running it through Cygwin so that the a2x toolchain functions properly. This works well for me but is a pain to setup on other Windows computers. I have been looking for alternative methods and recently revisited Sphinx. Noticing that it now produces HTML help files I gave it a try and it seems to work well in the small tests I performed.
My question is, is there a way to specify map id's for context sensitive help in the text so that my Windows programs can call the proper help API and the file is launched and opened to the desired location?
In AsciiDoc I am using pass::[<?dbhh topicname="_about" topicid="801"?>]. By using these constructs a context.h and alias.h are generated along with the other HTML help files (context sensitive help information).
如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱，如果其他用户或者作者回复了您的评论，将不能在第一时间通知您！
发布评论
评论（1）
我对 AcsiiDoc 不太了解，但在 Sphinx 中，您可以通过在需要的地方放置锚点来引用任意位置。请参阅
：ref ：角色。I do not know about AcsiiDoc much, but in Sphinx you can reference arbitrary locations by placing anchors where you need them. See
:ref:role.