Yocto Project Documentation
 help / color / mirror / Atom feed
From: "Antonin Godard" <antonin.godard@bootlin.com>
To: <quentin.schulz@cherry.de>, <docs@lists.yoctoproject.org>
Cc: "Thomas Petazzoni" <thomas.petazzoni@bootlin.com>
Subject: Re: [docs] [PATCH 3/3] brief-yoctoprojectqs/index.rst: switch shell block to to console lexer
Date: Fri, 28 Nov 2025 14:14:42 +0100	[thread overview]
Message-ID: <DEKCSVB1HLZ2.3SBMWDGD7547G@bootlin.com> (raw)
In-Reply-To: <DEKCQCLV0UHY.2TD6EXECC6FA6@bootlin.com>

On Fri Nov 28, 2025 at 2:11 PM CET, Antonin Godard wrote:
> Hi,
>
> On Thu Nov 27, 2025 at 5:47 PM CET, Quentin Schulz via lists.yoctoproject.org wrote:
> [...]
>>>   #. Choose a configuration (for example, ``poky-master``):
>>>   
>>> -   .. code-block:: shell
>>> +   .. code-block:: console
>>>   
>>
>> Neither shell nor console. I would suggest to simply use a literal block 
>> (::), c.f. 
>> https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#rst-literal-blocks
>
> Thanks, I'll change that.
>
> I just noticed but I think the default lexer for literal blocks is Python unless
> you explicitly set it to something else in the global configuration[1]. I think
> it makes sense to change it to "text" as the rendering looks odd in most places
> where it thinks it's Python code, whereas most of the time it's either text
> snippets or bitbake assignments.

Forgot the link :)

[1]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#literal-blocks

End of the paragraph:

Code highlighting can be enabled for these literal blocks on a document-wide
basis using the highlight directive and on a project-wide basis using the
highlight_language configuration option. The code-block directive can be used to
set highlighting on a block-by-block basis.

Antonin


  reply	other threads:[~2025-11-28 13:14 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-11-27 16:37 [PATCH 0/3] bitbake-setup updates Antonin Godard
2025-11-27 16:37 ` [PATCH 1/3] poky.yaml.in: add DISTRO_RELEASE_SERIES Antonin Godard
2025-11-27 16:37 ` [PATCH 2/3] brief-yoctoprojectqs/index.rst: update available bitbake-setup configurations Antonin Godard
2025-11-27 16:37 ` [PATCH 3/3] brief-yoctoprojectqs/index.rst: switch shell block to to console lexer Antonin Godard
2025-11-27 16:47   ` [docs] " Quentin Schulz
2025-11-28 13:11     ` Antonin Godard
2025-11-28 13:14       ` Antonin Godard [this message]
2025-11-28 13:30       ` Quentin Schulz
2025-11-28 13:46         ` Antonin Godard
2025-12-01  8:35 ` [PATCH 0/3] bitbake-setup updates Antonin Godard

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=DEKCSVB1HLZ2.3SBMWDGD7547G@bootlin.com \
    --to=antonin.godard@bootlin.com \
    --cc=docs@lists.yoctoproject.org \
    --cc=quentin.schulz@cherry.de \
    --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