Re: [Issue] sphinx: incorrect high-lighting

[Mauro Carvalho Chehab <mchehab+huawei@kernel.org>]

On Sun, 30 Aug 2026 09:13:31 +0200
Manuel Ebner <manuelebnerli@mailbox.org> wrote:

> On Mon, 2026-08-24 at 07:26 -0600, Jonathan Corbet wrote:
> > Manuel Ebner <manuelebnerli@mailbox.org> writes:
> >   
> > > It would be this list:
> > > Skipidentifiers = [ 'and', 'are', 'as', 'containing', 'element', 'in',
> > >                     'including', 'is', 'name', 'needs', 'of', 'or',  'page',
> > >                     'pages', 'passed', 'randomization', 'request', 'that',
> > >                     'to', 'where', 'which', 'whose', 'will' ]  
> > 
> > So this is an error-prone game of whac-a-mole...as Randy pointed out,
> > "struct page" is a rather important one in the kernel.
> > 
> > I can apply your updated version of this as a short-term fix, I guess,
> > but a better solution is probably to only apply markup to "struct foo"
> > if we have documentation for that type.  I can look into that later.  

There is actually a way to do that. See
Documentation/sphinx/kernel_include.py the code related to this:

    app.connect("missing-reference", check_missing_refs)

One option would be to re-convert such missing references back into
a normal "struct foo" if the reference was not found.

Not sure, however, how much this would affect Sphinx build time.

-- 
Thanks,
Mauro