From 4b58391cd203e092eebd09d1ede15b7dde1b454b Mon Sep 17 00:00:00 2001 From: Jiri Podivin Date: Mon, 30 May 2022 10:13:31 +0200 Subject: [PATCH] Skipping tests during API doc generation The tests subpackage isn't interesting from the user pov and only comes into play when either testing, writing new or debugging existing tests. As such it's only it's only interesting to people who already have immediate access to source and are familiar with our API. Documenting it in our manul isn't necessary. Signed-off-by: Jiri Podivin Change-Id: I0d179f1c0367378fa5c84121eb2e80a552774462 --- doc/source/conf.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index e99ec2c0..90d9fa5f 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -52,7 +52,9 @@ man_pages = [( # sphinxcontrib.apidoc options apidoc_module_dir = '../../validations_libs' apidoc_output_dir = 'reference/api' -apidoc_excluded_paths = [] +apidoc_excluded_paths = [ + 'tests' +] apidoc_separate_modules = True autoprogram_cliff_application = 'validation'