@@ -2707,6 +2707,21 @@ For information on setting up and running ptests, see the
":ref:`test-manual/ptest:testing packages with ptest`"
section in the Yocto Project Development Tasks Manual.
+.. _ref-classes-ptest-python-pytest:
+
+``ptest-python-pytest``
+=======================
+
+The :ref:`ref-classes-ptest-python-pytest` class can be used in Python-based
+recipes to automatically configure the :ref:`ref-classes-ptest` class for Python
+packages leveraging the `pytest <https://docs.pytest.org>`__ unit test framework.
+
+Within the recipe, the :term:`PTEST_PYTEST_DIR` variable can be overridden to
+specify the path to the directory containing the tests (default value:
+``tests``). Test contained in this directory are installed in :term:`D` by the
+:ref:`ref-tasks-install_ptest_base` task, as well as a specific ``run-ptest``
+script for this task.
+
.. _ref-classes-python3-dir:
``python3-dir``
@@ -7088,6 +7088,16 @@ system and gives an overview of their function and contents.
at build time should be done by adding "ptest" to (or removing it
from) :term:`DISTRO_FEATURES`.
+ :term:`PTEST_PYTEST_DIR`
+ Within the :ref:`ref-classes-ptest-python-pytest` class, the
+ :term:`PTEST_PYTEST_DIR` variable represents the path within the source
+ tree of a Python package holding the unit tests to be tested with the
+ `pytest <https://docs.pytest.org>`__ framework. The default value for this
+ variable is ``tests``.
+
+ For more information, see
+ the :ref:`ref-classes-ptest-python-pytest` class documentation.
+
:term:`PV`
The version of the recipe. The version is normally extracted from the
recipe filename. For example, if the recipe is named
Add documentation for the ptest-python-pytest class, and the PTEST_PYTEST_DIR variable which can be overriden. Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> --- documentation/ref-manual/classes.rst | 15 +++++++++++++++ documentation/ref-manual/variables.rst | 10 ++++++++++ 2 files changed, 25 insertions(+)