mbox series

[0/4] Document library functions

Message ID 20250418-library-functions-v1-0-3bbb836149d7@bootlin.com
Headers show
Series Document library functions | expand

Message

Antonin Godard April 18, 2025, 3:15 p.m. UTC 
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>