Re: Kernel docs: muddying the waters a bit

From: Jonathan Corbet
Date: Thu Feb 18 2016 - 08:01:16 EST


On Thu, 18 Feb 2016 10:24:04 +0100
Daniel Vetter <daniel.vetter@xxxxxxxx> wrote:

> > Worth noting is that, AFAICT, in all of the proposals, including the
> > original where kernel-doc produces docbook, this autoreferencing only
> > works within parts processed by kernel-doc. Not in the template
> > documents themselves. (You can still use the markup's more verbose cross
> > referencing keywords.)
>
> It works everywhere, even in the docbook template, as long as you mark
> it up correctly. Which in docbook means <function>func</function>.

In Sphinx that's :func:`function_name`. Not a thing of beauty, but it
works.

jon