Linux Documentation
 help / color / mirror / Atom feed
From: "Antonin Godard" <antonin.godard@bootlin.com>
To: "Jonathan Corbet" <corbet@lwn.net>,
	"Shuah Khan" <skhan@linuxfoundation.org>
Cc: "Thomas Petazzoni" <thomas.petazzoni@bootlin.com>,
	<linux-doc@vger.kernel.org>, <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH 0/2] Documentation: html: show sections in the sidebar
Date: Tue, 04 Aug 2026 15:59:58 +0200	[thread overview]
Message-ID: <DKG7P6BAPV5Q.1UO4XWHZT8H15@bootlin.com> (raw)
In-Reply-To: <87cxvzxbin.fsf@trenco.lwn.net>

Hi Jonathan,

On Mon Aug 3, 2026 at 9:13 PM CEST, Jonathan Corbet wrote:
[...]
> This looks like it could be a nice improvement, but I have a couple of
> thoughts...
>
> - Did you check the PDF build to be sure that the captions don't intrude
>   in some sort of obnoxious ways?

It isn't a problem for the Yocto Project documentation PDF. You can have a look
at the current PDF for it (with the ":caption:" properties):
https://docs.yoctoproject.org/dev/_static/theyoctoproject.pdf

And here would be the equivalent PDF with the ":caption:" properties _removed_:
https://lufi.bootlin.com/r/JbwZLTrHzJ#s/bmg9ZecGftbwZjvfJzaeh/ustGIzT1mKYJf5Yayu8=

I can't spot any differences.

I'm struggling to get things right to build the PDF for the kernel docs, so I
wasn't able to test it :-/ If you have some container image that I could use, it
might help as it seems to be related to my host packages versions.

For ePUBs, as Randy mentioned, TOC is handled differently and the captions are
not seen in odd places.

> - I'd tweak the CSS to remove the white space below the section
>   headings, just to bind them to their subsections properly.

Got it, I added that for the next version.

Thanks!
Antonin

      parent reply	other threads:[~2026-08-04 14:00 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-08-03 14:35 [PATCH 0/2] Documentation: html: show sections in the sidebar Antonin Godard
2026-08-03 14:35 ` [PATCH 1/2] " Antonin Godard
2026-08-03 17:20   ` Randy Dunlap
2026-08-03 14:35 ` [PATCH 2/2] Documentation: html: make sidebar section titles bold Antonin Godard
2026-08-03 17:20   ` Randy Dunlap
2026-08-03 19:13 ` [PATCH 0/2] Documentation: html: show sections in the sidebar Jonathan Corbet
2026-08-03 23:48   ` Randy Dunlap
2026-08-04 13:25     ` Jonathan Corbet
2026-08-04 13:59   ` Antonin Godard [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=DKG7P6BAPV5Q.1UO4XWHZT8H15@bootlin.com \
    --to=antonin.godard@bootlin.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=skhan@linuxfoundation.org \
    --cc=thomas.petazzoni@bootlin.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox