diff options
| author | Tom Rini <trini@konsulko.com> | 2025-05-07 16:08:18 -0600 |
|---|---|---|
| committer | Heinrich Schuchardt <heinrich.schuchardt@canonical.com> | 2025-05-11 12:52:56 +0200 |
| commit | a865d1d25410af97376fd3c822bac560b99fd84b (patch) | |
| tree | 2345341763377c92b2340cc77919ece665616dd7 /doc/develop/pytest | |
| parent | be2bdfd0199f37fed0ce19f90840f79d185e20d1 (diff) | |
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>
Diffstat (limited to 'doc/develop/pytest')
| -rw-r--r-- | doc/develop/pytest/index.rst | 8 | ||||
| -rw-r--r-- | doc/develop/pytest/test_000_version.rst | 8 |
2 files changed, 16 insertions, 0 deletions
diff --git a/doc/develop/pytest/index.rst b/doc/develop/pytest/index.rst index 435d84fc619..ca45e157d3b 100644 --- a/doc/develop/pytest/index.rst +++ b/doc/develop/pytest/index.rst @@ -10,3 +10,11 @@ General :maxdepth: 1 usage + +Individual tests +---------------- + +.. toctree:: + :maxdepth: 1 + + test_000_version diff --git a/doc/develop/pytest/test_000_version.rst b/doc/develop/pytest/test_000_version.rst new file mode 100644 index 00000000000..09e9a361729 --- /dev/null +++ b/doc/develop/pytest/test_000_version.rst @@ -0,0 +1,8 @@ +test_000_version +================ + +.. automodule:: test_000_version + :synopsis: + :member-order: bysource + :members: + :undoc-members: |