Yeah, with :func:`foo` you can make them in-line in the text. What I'm thinking of is having a code block, and have the links inline there. I.e. similar to the Qt documentation, for instance, here: http://doc-snapshot.qt-project.org/5.0/qabstractformbuilder.html The first code sample has links inline in it. Can this be done using the docutils API (assuming I know which words to highlight for a given code snippet) or directly when writing reST files?
Cheers, -t Am Montag, 30. April 2012 22:37:51 UTC+2 schrieb werner: > > On 30/04/2012 22:19, TJA wrote: > > I would be interested in that as well. If it can't be done automatically: > Is there a way to post-process the source-code manually to insert links (in > my case, I know all functions and I could easily add the links myself.) > > :func:`foo` should do, see: > http://sphinx.pocoo.org/markup/inline.html?highlight=reference > > Unless I misunderstand what you and Bryan like to get. > > Werner > > > Am Montag, 27. Februar 2012 23:51:18 UTC+1 schrieb Bryan: >> >> All, >> >> Is there some way for hilighted source code to include hyperlinks to >> classes/variables/etc that have been documented? So that >> >> .. function:: foo() >> >> A function. >> >> >> :: >> foo() # Would be nice if foo() were hyperlinked in the resulting .html >> >> >> Bryan >> -- >> Bryan A. Jones, Ph.D. >> Associate Professor >> Department of Electrical and Computer Engineering >> 231 Simrall / PO Box 9571 >> Mississippi State University >> Mississippi state, MS 39762 >> http://www.ece.msstate.edu/~bjones >> bjones AT ece DOT msstate DOT edu >> voice 662-325-3149 >> fax 662-325-2298 >> >> Our Master, Jesus Christ, is on his way. He'll show up right on >> time, his arrival guaranteed by the Blessed and Undisputed Ruler, >> High King, High God. >> - 1 Tim. 6:14b-15 (The Message) >> >> -- > You received this message because you are subscribed to the Google Groups > "sphinx-dev" group. > To view this discussion on the web visit > https://groups.google.com/d/msg/sphinx-dev/-/KTZ7mxGSp8cJ. > To post to this group, send email to [email protected]. > To unsubscribe from this group, send email to > [email protected]. > For more options, visit this group at > http://groups.google.com/group/sphinx-dev?hl=en. > > > -- You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To view this discussion on the web visit https://groups.google.com/d/msg/sphinx-dev/-/9u0vNjjYF4IJ. To post to this group, send email to [email protected]. To unsubscribe from this group, send email to [email protected]. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
