]> 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)
committerLaura Flores <lflores@redhat.com>
Thu, 24 Mar 2022 17:25:22 +0000 (12:25 -0500)
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 c4d5bfb49c684900de07613556822e3a72c6ab46..c4c8790d912e784151073599a9f59bec08c93e3c 100644 (file)
@@ -167,7 +167,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',
 }
 
 # graphviz options