我目前正在使用AsciiDoc(http://www.methods.co.nz/asciidoc/)来记录我的软件项目,因为它支持pdf和html帮助生成。我目前通过cygwin运行它,以便a2x工具链正常运行。这适用于我,但在其他Windows计算机上设置很痛苦。我一直在寻找其他方法,最近又重新审视了Sphinx。注意到它现在生成了html帮助文件,我尝试了一下,它似乎在我执行的小测试中运行良好。
我的问题是,有没有办法在文本中为上下文相关的帮助指定地图ID,以便我的Windows程序可以调用正确的帮助API并启动文件并打开到所需的位置?
在AsciiDoc中我使用“pass :: []”。通过使用这些构造,将生成context.h和alias.h以及其他html帮助文件(context sensitive help information)。
答案 0 :(得分:1)
我不太了解AcsiiDoc,但在Sphinx中,您可以通过将锚点放置在您需要的位置来引用任意位置。 http://sphinx.pocoo.org/markup/inline.html#ref-role