openstack/validations-libs
Code Issues Proposed changes

Skipping tests during API doc generation

Browse Source 
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 <jpodivin@redhat.com>
Change-Id: I0d179f1c0367378fa5c84121eb2e80a552774462
This commit is contained in:
Jiri Podivin 2022-05-30 10:13:31 +02:00
parent 79c6c886a8
commit 4b58391cd2
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/conf.py
View File

@ -52,7 +52,9 @@ man_pages = [(
# sphinxcontrib.apidoc options # sphinxcontrib.apidoc options
apidoc_module_dir = '../../validations_libs' apidoc_module_dir = '../../validations_libs'
apidoc_output_dir = 'reference/api' apidoc_output_dir = 'reference/api'
apidoc_excluded_paths = [] apidoc_excluded_paths = [
'tests'
]
apidoc_separate_modules = True apidoc_separate_modules = True
autoprogram_cliff_application = 'validation' autoprogram_cliff_application = 'validation'