Using sphinx to create html context sensitive help

Question

I am currently using AsciiDoc ( http://www.methods.co.nz/asciidoc/ ) to document my software projects as it supports creating help on pdf and html. I am currently running it through cygwin, so the a2x toolchain is functioning properly. This works well for me, but it is a pain to configure on other Windows computers. I was looking for alternative methods and the recently revised Sphinx. Noticing that he is now creating html help files, I gave it a try and it seems to work well in the small tests that I performed.

My question is, is there a way to specify a card identifier for context sensitive help in the text so that my Windows programs can call the correct api hint and the file is launched and opened in the right place?

In AsciiDoc, I use "pass :: []". Using these constructs, context.h and alias.h are created along with other html help files ( context help information ).

Answer 1

I am not very familiar with AcsiiDoc, but in Sphinx you can reference arbitrary locations by placing anchors where you need them. http://sphinx.pocoo.org/markup/inline.html#ref-role