Re: [PATCH 5/5] docs: improve the HTML formatting of kerneldoc comments
From: Jonathan Corbet
Date: Wed Oct 05 2022 - 11:30:00 EST
Mauro Carvalho Chehab <mchehab@xxxxxxxxxx> writes:
> Nitpick: you forgot to close the parenthesis on your comment ;-)
Hey, I gotta provide something for people to complain about :)
>> + #
>> + print ".. container:: kernelindent\n\n";
> I liked the new alignment: it makes easier to identify what belongs
> to each definition block.
> As I didn't test the patches, it sounds worth mentioning that it makes
> sense to check if this won't badly affect epub and/or LaTeX/PDF outputs.
> The LaTeX output generator in particular has a problem with long
> lines with fixed-width lines: if the text doesn't fit into one line, it
> either truncates it or makes the text go outside the margins.
> If the container affects the PDF outputs, we need to double-check if
> this would break its output.
The __container:: directive is pretty much defined as contributing a
<div> do the HTML output, so I do not expect problems. That said, I've
not yet tested it, and clearly need to.
> Also, when the container directive was introduced? Does it affect
> the minimal Sphinx version we support? It seems that this was old
> enough to not require any changes at the minimal version, but,
> from https://www.sphinx-doc.org/en/master/changes.html, it seems
> that LaTeX support for it was added only at Sphinx v4.1 on this PR:
> So, we need to double-check if are there any changes before and after
> such version at the places container is used - or change the kerneldoc
> to only emit such tags on PDF depending on the Sphinx version.
I've tested things as far back as 2.4.5, where all is well. I don't
currently have a machine that is capable of running earlier versions;
I'll need to conjure one of those up, I guess.
(Either that or just bite the bullet and move the minimum version