From: Trevor Woerner <twoerner@gmail.com>
To: docs@lists.yoctoproject.org
Cc: Trevor Woerner <trevor.woerner@amd.com>
Subject: [RFC PATCH 0/2] support bitbake blocks
Date: Tue, 21 Apr 2026 13:24:14 -0400 [thread overview]
Message-ID: <20260421172416.1801567-1-twoerner@gmail.com> (raw)
From: Trevor Woerner <trevor.woerner@amd.com>
Out of the box, Pygments does not handle bitbake blocks for syntax
highlighting. As a result the numerous bitbake examples and snippets
throughout our documentation use a basic, non-bitbake-specific
highlighting.
This patchset adds a custom lexer to support bitbake syntax, based on
the vim syntax highlighting information in [1], adds it to the sphinx
extensions, and then goes through the BSP Developer's Guide identifying
and re-formatting any bitbake blocks as "..code-block: bitbake".
If this RFC is acceptable, I can update it to convert all such blocks
throughout the entire documentation set.
[1] https://git.openembedded.org/bitbake/tree/contrib/vim
Trevor Woerner (2):
add a "bitbake" pygments lexer
BSP dev guide: update to use bitbake lexer
documentation/bsp-guide/bsp.rst | 40 +++++--
documentation/conf.py | 3 +-
documentation/sphinx/bitbake.py | 195 ++++++++++++++++++++++++++++++++
3 files changed, 227 insertions(+), 11 deletions(-)
create mode 100644 documentation/sphinx/bitbake.py
--
2.50.0.173.g8b6f19ccfc3a
next reply other threads:[~2026-04-21 17:24 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-04-21 17:24 Trevor Woerner [this message]
2026-04-21 17:24 ` [RFC PATCH 1/2] add a "bitbake" pygments lexer Trevor Woerner
2026-04-22 6:55 ` [docs] " Antonin Godard
2026-04-22 17:15 ` Trevor Woerner
2026-04-22 19:33 ` Trevor Woerner
2026-04-23 7:39 ` Antonin Godard
2026-04-21 17:24 ` [RFC PATCH 2/2] BSP dev guide: update to use bitbake lexer Trevor Woerner
2026-04-21 19:36 ` [RFC PATCH 0/2] support bitbake blocks Trevor Woerner
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=20260421172416.1801567-1-twoerner@gmail.com \
--to=twoerner@gmail.com \
--cc=docs@lists.yoctoproject.org \
--cc=trevor.woerner@amd.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