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/conf.py | |
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/conf.py')
-rw-r--r-- | doc/conf.py | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/conf.py b/doc/conf.py index 3cb9b2bb65e..84d028feda8 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -48,7 +48,7 @@ extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include', 'kfigure', 'sphinx.ext.ifconfig', # 'automarkup', 'maintainers_include', 'sphinx.ext.autosectionlabel', 'kernel_abi', 'kernel_feat', 'sphinx-prompt', - 'sphinx_reredirects' ] + 'sphinx_reredirects', 'sphinx.ext.autodoc' ] # # cdomain is badly broken in Sphinx 3+. Leaving it out generates *most* |