diff mbox series

[v2,03/16] ref-manual/classes.rst: document the python_pdm class

Message ID 20251024-release-note-5-3-second-hunk-v2-3-d15dabc095d0@bootlin.com
State Under Review
Headers show
Series Updates for 5.3 | expand

Commit Message

Antonin Godard Oct. 24, 2025, 8:19 a.m. UTC
This class was added by commit 20758865e9e0 ("classes/python_pdm: add
PEP517 build class for PDM") in OE-Core.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/ref-manual/classes.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)

Comments

Quentin Schulz Oct. 24, 2025, 3:06 p.m. UTC | #1
Hi Antonin,

On 10/24/25 10:19 AM, Antonin Godard via lists.yoctoproject.org wrote:
> This class was added by commit 20758865e9e0 ("classes/python_pdm: add
> PEP517 build class for PDM") in OE-Core.
> 
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
>   documentation/ref-manual/classes.rst | 10 ++++++++++
>   1 file changed, 10 insertions(+)
> 
> diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
> index b92b9e28b..f93897be1 100644
> --- a/documentation/ref-manual/classes.rst
> +++ b/documentation/ref-manual/classes.rst
> @@ -2174,6 +2174,16 @@ meson-python build system.
>   
>   Internally this uses the :ref:`ref-classes-python_pep517` class.
>   
> +.. _ref-classes-python_pdm:
> +
> +``python_pdm``
> +=================
> +
> +The :ref:`ref-classes-python_pdm` class adds support for building Python
> +packages with the `PDM <https://pdm-project.org/>`__ package and dependency manager.
> +This class adds  ``python3-pdm-backend-native`` to the recipe's build-time

If you want a visual newline between the first and second sentence, you 
need a newline between them in rST otherwise it'll be part of the same 
paragraph.

Considering the flit class states that it internally uses the 
python-pep517 class and that the python_pdm class does as well, should 
we specify it in the documentation as well?

Cheers,
Quentin
diff mbox series

Patch

diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index b92b9e28b..f93897be1 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -2174,6 +2174,16 @@  meson-python build system.
 
 Internally this uses the :ref:`ref-classes-python_pep517` class.
 
+.. _ref-classes-python_pdm:
+
+``python_pdm``
+=================
+
+The :ref:`ref-classes-python_pdm` class adds support for building Python
+packages with the `PDM <https://pdm-project.org/>`__ package and dependency manager.
+This class adds  ``python3-pdm-backend-native`` to the recipe's build-time
+dependencies.
+
 .. _ref-classes-python_pep517:
 
 ``python_pep517``