public inbox for docs@lists.yoctoproject.org
 help / color / mirror / Atom feed
From: Quentin Schulz <quentin.schulz@cherry.de>
To: rpjday@crashcourse.ca,
	YP docs mailing list <docs@lists.yoctoproject.org>
Subject: Re: [docs] is there any way to render content in italics in a code block?
Date: Thu, 15 Jan 2026 11:06:02 +0100	[thread overview]
Message-ID: <78dfab73-8d58-4cbd-b452-d34c1cc14ae4@cherry.de> (raw)
In-Reply-To: <5eef4c2b-95ae-cc22-b44c-a03e29982c79@crashcourse.ca>

Hi Robert,

On 1/8/26 10:33 PM, Robert P. J. Day via lists.yoctoproject.org wrote:
> 
>    one aspect of sphinx that gripes my wagger is that there does not
> seem to be any easy way to tag something in italics in a code block.
> 
> here:
> 
> https://docs.yoctoproject.org/bitbake/bitbake-user-manual/bitbake-user-manual-execution.html
> 
> the code line:
> 
>   $ bitbake target
> 
> really needs the word "target" in italics to show that it's meant to
> be replaced. and, no, this isn't minor nitpicking -- the whole section
> on overrides desperately needs to be able to show what things a
> developer is meant to replace.
> 
>    is there any way to do this?
> 

Not that I know of.

Another option is to follow conventions from manpages for example or 
something people are most familiar with.

bitbake [target]...

maybe? I'm not versed in manpages.

Also, you can simply specify after the code-block what must be changed 
by the user. It doesn't *have* to be a technical solution.

code-blocks have :emphasize-lines: maybe there's room for adding 
emphasize-columns or something like that such that we can specify what 
to highlight in a line.

Cheers,
Quentin


  parent reply	other threads:[~2026-01-15 10:06 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-01-08 21:36 is there any way to render content in italics in a code block? Robert P. J. Day
2026-01-09  9:39 ` [docs] " Antonin Godard
2026-01-15 10:06 ` Quentin Schulz [this message]
2026-01-15 15:58   ` Robert P. J. Day
2026-01-15 16:17     ` Quentin Schulz
2026-01-15 21:19       ` Robert P. J. Day

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=78dfab73-8d58-4cbd-b452-d34c1cc14ae4@cherry.de \
    --to=quentin.schulz@cherry.de \
    --cc=docs@lists.yoctoproject.org \
    --cc=rpjday@crashcourse.ca \
    /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