diff mbox series

[v2] ref-manual: classes.rst: add python-setuptools3_rust and python_pyo3 classes

Message ID 20230214113952.41425-1-michael.opdenacker@bootlin.com
State New
Headers show
Series [v2] ref-manual: classes.rst: add python-setuptools3_rust and python_pyo3 classes | expand

Commit Message

Michael Opdenacker Feb. 14, 2023, 11:39 a.m. UTC 
From: Michael Opdenacker <michael.opdenacker@bootlin.com>

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Cc: Tim Orling <ticotimo@gmail.com>
Cc: Alex Kiernan <alex.kiernan@gmail.com>
Cc: Quentin Schulz <quentin.schulz@theobroma-systems.com>

---

Changes in V2:
- Reword to highlight that python_pyo3 is internal to python-setuptools3_rust,
  as pointed out by Quentin Schulz
---
 documentation/ref-manual/classes.rst | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
diff mbox series

Patch

diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index b5443c0d0a..310be59912 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -2231,6 +2231,31 @@  The :ref:`ref-classes-python_poetry_core` class enables building Python modules
 
 Internally this uses the :ref:`ref-classes-python_pep517` class.
 
+.. _ref-classes-python_pyo3:
+
+``python_pyo3``
+===============
+
+The :ref:`ref-classes-python_pyo3` class helps make sure that Python extensions
+written in Rust and built with `PyO3 <https://pyo3.rs/>`__, properly set up the
+environment for cross compilation.
+
+This class is internal to the :ref:`ref-classes-python-setuptools3_rust` class
+and is not meant to be used directly in recipes.
+
+.. _ref-classes-python-setuptools3_rust:
+
+``python-setuptools3_rust``
+===========================
+
+The :ref:`ref-classes-python-setuptools3_rust` class enables building Python
+extensions implemented in Rust with `PyO3 <https://pyo3.rs/>`__, which allows
+to compile and distribute Python extensions written in Rust as easily
+as if they were written in C.
+
+This class inherits the :ref:`ref-classes-setuptools3` and
+:ref:`ref-classes-python_pyo3` classes.
+
 .. _ref-classes-pixbufcache:
 
 ``pixbufcache``