From 22e130ae7a0b43dcb76660c287e600ddf1f2a27b Mon Sep 17 00:00:00 2001 From: Kefu Chai Date: Sun, 6 Mar 2022 14:27:50 +0800 Subject: [PATCH] doc/conf.py: silence warnings from breathe 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 (cherry picked from commit 8891d653198c30f9578499126e1ee9ee67eca04a) --- doc/conf.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/conf.py b/doc/conf.py index c5638baa4f11d..2a3a134e4e046 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -102,7 +102,8 @@ breathe_domain_by_extension = {'py': 'py', 'c': 'c', 'h': 'c', 'cc': 'cxx', 'hpp breathe_doxygen_config_options = { 'EXPAND_ONLY_PREDEF': 'YES', 'MACRO_EXPANSION': 'YES', - 'PREDEFINED': 'CEPH_RADOS_API= ' + 'PREDEFINED': 'CEPH_RADOS_API= ', + 'WARN_IF_UNDOCUMENTED': 'NO', } # the docs are rendered with github links pointing to master. the javascript -- 2.39.5