doc: pytest: Framework for documenting tests and document test_000_version
authorTom Rini <trini@konsulko.com>
Wed, 7 May 2025 22:08:18 +0000 (16:08 -0600)
committerHeinrich Schuchardt <heinrich.schuchardt@canonical.com>
Sun, 11 May 2025 10:52:56 +0000 (12:52 +0200)
commita865d1d25410af97376fd3c822bac560b99fd84b
tree2345341763377c92b2340cc77919ece665616dd7
parentbe2bdfd0199f37fed0ce19f90840f79d185e20d1
doc: pytest: Framework for documenting tests and document test_000_version

In order to easily document pytests, we need to include the autodoc
extension. We also need to make sure that for building the docs, CI
includes pytest and that we have PYTHONPATH configured such that it will
find all of the tests and related files. Finally, we need to have our
comments in the test file by in proper pydoc format in order to be
included in the output.

Signed-off-by: Tom Rini <trini@konsulko.com>
Reviewed-by: Simon Glass <sjg@chromium.org>
.azure-pipelines.yml
.gitlab-ci.yml
Makefile
doc/conf.py
doc/develop/pytest/index.rst
doc/develop/pytest/test_000_version.rst [new file with mode: 0644]
test/py/tests/test_000_version.py