From: Antonin Godard <antonin.godard@bootlin.com>
To: bitbake-devel@lists.openembedded.org
Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com>,
docs@lists.yoctoproject.org,
Antonin Godard <antonin.godard@bootlin.com>
Subject: [PATCH 0/4] Document library functions
Date: Fri, 18 Apr 2025 17:15:24 +0200 [thread overview]
Message-ID: <20250418-library-functions-v1-0-3bbb836149d7@bootlin.com> (raw)
Use the Sphinx autodoc extensions to document the functions from lib/.
For now logging utilities and bb.utils functions are automatically
documented. Some syntax a formatting needed to be done for the doc to
render properly.
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
Antonin Godard (4):
utils: format and improve docstrings
lib/bb: format and improve logging docstrings
doc: add a new Library Functions document
doc: bitbake-user-manual-metadata: provide link to new doc
.../bitbake-user-manual-library-functions.rst | 59 ++
.../bitbake-user-manual-metadata.rst | 7 +-
doc/conf.py | 7 +
doc/index.rst | 1 +
lib/bb/__init__.py | 76 ++-
lib/bb/utils.py | 601 ++++++++++++++++-----
6 files changed, 592 insertions(+), 159 deletions(-)
---
base-commit: 24772dd2ae6c0cd11540a260f15065f906fb0997
change-id: 20250418-library-functions-6981354bba94
Best regards,
--
Antonin Godard <antonin.godard@bootlin.com>
next reply other threads:[~2025-04-18 15:16 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-04-18 15:15 Antonin Godard [this message]
2025-04-18 15:15 ` [PATCH 1/4] utils: format and improve docstrings Antonin Godard
2025-04-22 16:24 ` [bitbake-devel] " Quentin Schulz
2025-04-18 15:15 ` [PATCH 2/4] lib/bb: format and improve logging docstrings Antonin Godard
2025-04-22 16:49 ` [bitbake-devel] " Quentin Schulz
2025-04-18 15:15 ` [PATCH 3/4] doc: add a new Library Functions document Antonin Godard
2025-04-22 16:49 ` [bitbake-devel] " Quentin Schulz
2025-04-18 15:15 ` [PATCH 4/4] doc: bitbake-user-manual-metadata: provide link to new doc Antonin Godard
2025-04-24 10:54 ` [bitbake-devel] [PATCH 0/4] Document library functions Richard Purdie
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=20250418-library-functions-v1-0-3bbb836149d7@bootlin.com \
--to=antonin.godard@bootlin.com \
--cc=bitbake-devel@lists.openembedded.org \
--cc=docs@lists.yoctoproject.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.