]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/conf.py: silence warnings from breathe
authorKefu Chai <tchaikov@gmail.com>
Sun, 6 Mar 2022 06:27:50 +0000 (14:27 +0800)
committerDavid Galloway <dgallowa@redhat.com>
Tue, 12 Apr 2022 14:04:01 +0000 (10:04 -0400)
breathe calls doxygen for extracting/generating docs from code.
while doxygen complains at seeing undocumented fields/func. these
warnings could fail the sphinx-build command, if it takes warnings
as errors.

in this change, these warnings are silenced.

Signed-off-by: Kefu Chai <tchaikov@gmail.com>
(cherry picked from commit 8891d653198c30f9578499126e1ee9ee67eca04a)

doc/conf.py

index 8ba08573ae7d2db7041539afb95e000e8cbd761e..9011b7497fbba2ae0681f24226bb9cfdfdb139d1 100644 (file)
@@ -143,7 +143,8 @@ breathe_domain_by_extension = {'py': 'py',
 breathe_doxygen_config_options = {
     'EXPAND_ONLY_PREDEF': 'YES',
     'MACRO_EXPANSION': 'YES',
-    'PREDEFINED': 'CEPH_RADOS_API= '
+    'PREDEFINED': 'CEPH_RADOS_API= ',
+    'WARN_IF_UNDOCUMENTED': 'NO',
 }
 
 # edit_on_github options