[PATCH 3/3] doc: pytest: Document the test_button test

[Simon Glass]

On Thu, 8 May 2025 at 23:42, Tom Rini <trini at konsulko.com> wrote:
>
> Add this test to the documentation. No changes to the test itself were
> required.
>
> Signed-off-by: Tom Rini <trini at konsulko.com>
> ---
> Cc: Heinrich Schuchardt <xypron.glpk at gmx.de>
> Cc: Simon Glass <sjg at chromium.org>
> ---
>  doc/develop/pytest/index.rst       | 1 +
>  doc/develop/pytest/test_button.rst | 8 ++++++++
>  test/py/tests/test_button.py       | 2 ++
>  3 files changed, 11 insertions(+)
>  create mode 100644 doc/develop/pytest/test_button.rst

Reviewed-by: Simon Glass <sjg at chromium.org>


>
> diff --git a/doc/develop/pytest/index.rst b/doc/develop/pytest/index.rst
> index 4d949cfd1d2d..0a7c1b21a24b 100644
> --- a/doc/develop/pytest/index.rst
> +++ b/doc/develop/pytest/index.rst
> @@ -21,6 +21,7 @@ Individual tests
>     test_bind
>     test_bootmenu
>     test_bootstage
> +   test_button
>     test_efi_loader
>     test_net
>     test_net_boot
> diff --git a/doc/develop/pytest/test_button.rst b/doc/develop/pytest/test_button.rst
> new file mode 100644
> index 000000000000..4e5a29f20a7b
> --- /dev/null
> +++ b/doc/develop/pytest/test_button.rst
> @@ -0,0 +1,8 @@
> +test_button
> +===========
> +
> +.. automodule:: test_button
> +   :synopsis:
> +   :member-order: bysource
> +   :members:
> +   :undoc-members:
> diff --git a/test/py/tests/test_button.py b/test/py/tests/test_button.py
> index f0d85be896d8..f3f68169e148 100644
> --- a/test/py/tests/test_button.py
> +++ b/test/py/tests/test_button.py
> @@ -1,5 +1,7 @@
>  # SPDX-License-Identifier: GPL-2.0+
>
> +"""Tests for the button command"""
> +
>  import pytest
>
>  @pytest.mark.boardspec('sandbox')
> --
> 2.43.0
>