diff mbox series

python3-breathe: new recipe version 4.36.0

Message ID 20250330101938.2634400-1-jan.vermaete@gmail.com
State New
Headers show
Series python3-breathe: new recipe version 4.36.0 | expand

Commit Message

Jan Vermaete March 30, 2025, 10:19 a.m. UTC
Breathe is a Sphinx plugin providing beautifully integrated Doxygen output in your user-facing documentation

Signed-off-by: Jan Vermaete <jan.vermaete@gmail.com>
---
 .../distro/include/ptest-packagelists.inc     |  1 +
 .../python/python3-breathe/run-ptest          |  3 +++
 .../python/python3-breathe_4.36.0.bb          | 22 +++++++++++++++++++
 3 files changed, 26 insertions(+)
 create mode 100644 meta/recipes-devtools/python/python3-breathe/run-ptest
 create mode 100644 meta/recipes-devtools/python/python3-breathe_4.36.0.bb

Comments

Richard Purdie March 30, 2025, 2 p.m. UTC | #1
On Sun, 2025-03-30 at 12:19 +0200, Jan Vermaete via lists.openembedded.org wrote:
> Breathe is a Sphinx plugin providing beautifully integrated Doxygen output in your user-facing documentation
> 
> Signed-off-by: Jan Vermaete <jan.vermaete@gmail.com>
> ---
>  .../distro/include/ptest-packagelists.inc     |  1 +
>  .../python/python3-breathe/run-ptest          |  3 +++
>  .../python/python3-breathe_4.36.0.bb          | 22 +++++++++++++++++++
>  3 files changed, 26 insertions(+)
>  create mode 100644 meta/recipes-devtools/python/python3-breathe/run-ptest
>  create mode 100644 meta/recipes-devtools/python/python3-breathe_4.36.0.bb

A key question is whether this is needed in OE-Core? Are there recipes
in core that are going to need to depend upon this soon? Or is there
some other reason we need it here rather than in some other layer?

Cheers,

Richard
Jan Vermaete March 30, 2025, 2:31 p.m. UTC | #2
Hi Richard,

I thought because python3-breath and python3-exhale are closely
related to python3-sphinx.  And that one is in oe-core.

On Sun, Mar 30, 2025 at 4:00 PM Richard Purdie
<richard.purdie@linuxfoundation.org> wrote:
>
> On Sun, 2025-03-30 at 12:19 +0200, Jan Vermaete via lists.openembedded.org wrote:
> > Breathe is a Sphinx plugin providing beautifully integrated Doxygen output in your user-facing documentation
> >
> > Signed-off-by: Jan Vermaete <jan.vermaete@gmail.com>
> > ---
> >  .../distro/include/ptest-packagelists.inc     |  1 +
> >  .../python/python3-breathe/run-ptest          |  3 +++
> >  .../python/python3-breathe_4.36.0.bb          | 22 +++++++++++++++++++
> >  3 files changed, 26 insertions(+)
> >  create mode 100644 meta/recipes-devtools/python/python3-breathe/run-ptest
> >  create mode 100644 meta/recipes-devtools/python/python3-breathe_4.36.0.bb
>
> A key question is whether this is needed in OE-Core? Are there recipes
> in core that are going to need to depend upon this soon? Or is there
> some other reason we need it here rather than in some other layer?
>
> Cheers,
>
> Richard
>
Trevor Gamblin March 30, 2025, 4:36 p.m. UTC | #3
On 2025-03-30 10:31, Jan Vermaete via lists.openembedded.org wrote:
> Hi Richard,
>
> I thought because python3-breath and python3-exhale are closely
> related to python3-sphinx.  And that one is in oe-core.

If they aren't required by anything in oe-core but extend sphinx's 
capabilities, then it's probably fine to put them in the meta-python 
layer instead.

If you're adding new recipes, you should also be specifying yourself as 
the maintainer for them in this file:

meta/conf/distro/include/maintainers.inc

>
> On Sun, Mar 30, 2025 at 4:00 PM Richard Purdie
> <richard.purdie@linuxfoundation.org> wrote:
>> On Sun, 2025-03-30 at 12:19 +0200, Jan Vermaete via lists.openembedded.org wrote:
>>> Breathe is a Sphinx plugin providing beautifully integrated Doxygen output in your user-facing documentation
>>>
>>> Signed-off-by: Jan Vermaete <jan.vermaete@gmail.com>
>>> ---
>>>   .../distro/include/ptest-packagelists.inc     |  1 +
>>>   .../python/python3-breathe/run-ptest          |  3 +++
>>>   .../python/python3-breathe_4.36.0.bb          | 22 +++++++++++++++++++
>>>   3 files changed, 26 insertions(+)
>>>   create mode 100644 meta/recipes-devtools/python/python3-breathe/run-ptest
>>>   create mode 100644 meta/recipes-devtools/python/python3-breathe_4.36.0.bb
>> A key question is whether this is needed in OE-Core? Are there recipes
>> in core that are going to need to depend upon this soon? Or is there
>> some other reason we need it here rather than in some other layer?
>>
>> Cheers,
>>
>> Richard
>>
>
>
> -=-=-=-=-=-=-=-=-=-=-=-
> Links: You receive all messages sent to this group.
> View/Reply Online (#213919): https://lists.openembedded.org/g/openembedded-core/message/213919
> Mute This Topic: https://lists.openembedded.org/mt/111984549/7611679
> Group Owner: openembedded-core+owner@lists.openembedded.org
> Unsubscribe: https://lists.openembedded.org/g/openembedded-core/unsub [tgamblin@baylibre.com]
> -=-=-=-=-=-=-=-=-=-=-=-
>
Jan Vermaete March 30, 2025, 4:45 p.m. UTC | #4
I will resend them into meta-python.
please ignore the python-breathe and python-exhale patches.
Thanks for the review

On Sun, Mar 30, 2025 at 6:36 PM Trevor Gamblin <tgamblin@baylibre.com> wrote:
>
>
> On 2025-03-30 10:31, Jan Vermaete via lists.openembedded.org wrote:
> > Hi Richard,
> >
> > I thought because python3-breath and python3-exhale are closely
> > related to python3-sphinx.  And that one is in oe-core.
>
> If they aren't required by anything in oe-core but extend sphinx's
> capabilities, then it's probably fine to put them in the meta-python
> layer instead.
>
> If you're adding new recipes, you should also be specifying yourself as
> the maintainer for them in this file:
>
> meta/conf/distro/include/maintainers.inc
>
> >
> > On Sun, Mar 30, 2025 at 4:00 PM Richard Purdie
> > <richard.purdie@linuxfoundation.org> wrote:
> >> On Sun, 2025-03-30 at 12:19 +0200, Jan Vermaete via lists.openembedded.org wrote:
> >>> Breathe is a Sphinx plugin providing beautifully integrated Doxygen output in your user-facing documentation
> >>>
> >>> Signed-off-by: Jan Vermaete <jan.vermaete@gmail.com>
> >>> ---
> >>>   .../distro/include/ptest-packagelists.inc     |  1 +
> >>>   .../python/python3-breathe/run-ptest          |  3 +++
> >>>   .../python/python3-breathe_4.36.0.bb          | 22 +++++++++++++++++++
> >>>   3 files changed, 26 insertions(+)
> >>>   create mode 100644 meta/recipes-devtools/python/python3-breathe/run-ptest
> >>>   create mode 100644 meta/recipes-devtools/python/python3-breathe_4.36.0.bb
> >> A key question is whether this is needed in OE-Core? Are there recipes
> >> in core that are going to need to depend upon this soon? Or is there
> >> some other reason we need it here rather than in some other layer?
> >>
> >> Cheers,
> >>
> >> Richard
> >>
> >
> >
> > -=-=-=-=-=-=-=-=-=-=-=-
> > Links: You receive all messages sent to this group.
> > View/Reply Online (#213919): https://lists.openembedded.org/g/openembedded-core/message/213919
> > Mute This Topic: https://lists.openembedded.org/mt/111984549/7611679
> > Group Owner: openembedded-core+owner@lists.openembedded.org
> > Unsubscribe: https://lists.openembedded.org/g/openembedded-core/unsub [tgamblin@baylibre.com]
> > -=-=-=-=-=-=-=-=-=-=-=-
> >
diff mbox series

Patch

diff --git a/meta/conf/distro/include/ptest-packagelists.inc b/meta/conf/distro/include/ptest-packagelists.inc
index f3fdededf6..880178488f 100644
--- a/meta/conf/distro/include/ptest-packagelists.inc
+++ b/meta/conf/distro/include/ptest-packagelists.inc
@@ -57,6 +57,7 @@  PTESTS_FAST = "\
     python3-atomicwrites \
     python3-attrs \
     python3-bcrypt \
+    python3-breathe \
     python3-calver \
     python3-hypothesis \
     python3-idna \
diff --git a/meta/recipes-devtools/python/python3-breathe/run-ptest b/meta/recipes-devtools/python/python3-breathe/run-ptest
new file mode 100644
index 0000000000..8d2017d39c
--- /dev/null
+++ b/meta/recipes-devtools/python/python3-breathe/run-ptest
@@ -0,0 +1,3 @@ 
+#!/bin/sh
+
+pytest --automake
diff --git a/meta/recipes-devtools/python/python3-breathe_4.36.0.bb b/meta/recipes-devtools/python/python3-breathe_4.36.0.bb
new file mode 100644
index 0000000000..dc14f1ce1c
--- /dev/null
+++ b/meta/recipes-devtools/python/python3-breathe_4.36.0.bb
@@ -0,0 +1,22 @@ 
+SUMMARY = "Sphinx Doxygen renderer"
+DESCRIPTION = "Breathe is a Sphinx plugin providing beautifully integrated Doxygen output in your user-facing documentation."
+HOMEPAGE = "https://www.breathe-doc.org/"
+LICENSE = "BSD-3-Clause"
+LIC_FILES_CHKSUM = "file://LICENSE;md5=9e49eecf36fc015de7c61a0247df75d6"
+
+SRC_URI[sha256sum] = "14860b73118ac140b7a3f55446890c777d1b67149cb024279fe3710dad7f535c"
+
+inherit pypi python_flit_core ptest
+
+SRC_URI:append = " file://run-ptest"
+
+RDEPENDS:${PN} = "python3-sphinx"
+
+PYPI_PACKAGE = "breathe"
+
+do_install_ptest() {
+        install -d ${D}${PTEST_PATH}/tests
+        cp -rf ${S}/tests/* ${D}${PTEST_PATH}/tests/
+}
+
+BBCLASSEXTEND =+ "native"