diff mbox series

[2/9] ref-manual: add new python classes

Message ID 1fb3884b4272884ba85be9fb71ca8cc03b9be014.1713127068.git.bluelightning@bluelightning.org
State New
Headers show
Series [1/9] ref-manual: Add virtual-slash QA check | expand

Commit Message

Paul Eggleton April 14, 2024, 8:43 p.m. UTC
Add brief documentation of python_maturin and python_mesonpy classes
that were added in 5.0.

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
---
 documentation/ref-manual/classes.rst | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

Comments

Michael Opdenacker April 15, 2024, 1:43 p.m. UTC | #1
Hi Paul

Many thanks for these additions to the release notes.

On 4/14/24 at 22:43, Paul Eggleton wrote:
> Add brief documentation of python_maturin and python_mesonpy classes
> that were added in 5.0.
>
> Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
> ---
>   documentation/ref-manual/classes.rst | 18 ++++++++++++++++++
>   1 file changed, 18 insertions(+)
>
> diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
> index 296347edb7..1f816e0457 100644
> --- a/documentation/ref-manual/classes.rst
> +++ b/documentation/ref-manual/classes.rst
> @@ -2380,6 +2380,24 @@ Python modules built with ``flit_core.buildapi`` are pure Python (no
>   
>   Internally this uses the :ref:`ref-classes-python_pep517` class.
>   
> +.. _ref-classes-python_maturin:
> +
> +``python_maturin``
> +==================
> +
> +The :ref:`ref-classes-python_maturin` class provides support for python-maturin, a replacement
> +for setuptools_rust and another "backend" for building python wheels.


s/python wheels/Python Wheels/
Fixed

> +
> +.. _ref-classes-python_mesonpy:
> +
> +``python_mesonpy``
> +==================
> +
> +The :ref:`ref-classes-python_mesonpy` class enables building Python modules which use the
> +meson-python build system.
> +
> +Internally this uses the :ref:`ref-classes-python_pep517` class.


Everything all right here, though all these project names caused me to 
submit a way of highlighting the project names, to distinguish them from 
command names and common words. See 
https://lore.kernel.org/yocto-docs/20240415124735.1060654-1-michael.opdenacker@bootlin.com/T/#u

So, when this is accepted, I'll probably replace "Python Wheels" by 
"`Python Wheels`". :-)

Thanks
Michael.
diff mbox series

Patch

diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 296347edb7..1f816e0457 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -2380,6 +2380,24 @@  Python modules built with ``flit_core.buildapi`` are pure Python (no
 
 Internally this uses the :ref:`ref-classes-python_pep517` class.
 
+.. _ref-classes-python_maturin:
+
+``python_maturin``
+==================
+
+The :ref:`ref-classes-python_maturin` class provides support for python-maturin, a replacement
+for setuptools_rust and another "backend" for building python wheels.
+
+.. _ref-classes-python_mesonpy:
+
+``python_mesonpy``
+==================
+
+The :ref:`ref-classes-python_mesonpy` class enables building Python modules which use the
+meson-python build system.
+
+Internally this uses the :ref:`ref-classes-python_pep517` class.
+
 .. _ref-classes-python_pep517:
 
 ``python_pep517``