Skip to content

Commit

Permalink
doc: allow warnings in Sphinx for DTS
Browse files Browse the repository at this point in the history
Sphinx-autodoc issues warnings about some symbols due to bad autodoc
"automock"ing when optional dependencies are missing:

Warning, treated as error:
	Failed to get a method signature for
	framework.config.TestSuiteConfig.convert_from_string:
	<classmethod(<function TestSuiteConfig.convert_from_string
	at 0x7f1a4ec10790>)> is not a callable object

The current meson setup allows to treat warnings as errors, halting the
process and exiting early. Given these warnings should be ignored, this
patch removes this behavior. Until optional dependencies are detected,
warnings for DTS API docs will be checked manually as part of the DTS
approval process.

Fixes: 6597fa4 ("dts: add autodoc Pydantic")

Signed-off-by: Luca Vizzarro <[email protected]>
  • Loading branch information
Sevenarth authored and tmonjalo committed Nov 20, 2024
1 parent 0c0cd5f commit f4ccce5
Showing 1 changed file with 0 additions and 3 deletions.
3 changes: 0 additions & 3 deletions doc/api/dts/meson.build
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@ if python_ver_satisfied != 0
endif

extra_sphinx_args = ['-E', '-c', join_paths(doc_source_dir, 'guides')]
if get_option('werror')
extra_sphinx_args += '-W'
endif

# DTS docs are generated inside main Doxygen docs build directory
# DTS docs relies on main docs to install it so does not define install dir
Expand Down

0 comments on commit f4ccce5

Please sign in to comment.