diff options
| author | Kefu Chai <tchaikov@gmail.com> | 2022-03-06 07:27:50 +0100 |
|---|---|---|
| committer | Kefu Chai <tchaikov@gmail.com> | 2022-03-06 07:27:55 +0100 |
| commit | 8891d653198c30f9578499126e1ee9ee67eca04a (patch) | |
| tree | 3ec8b0bf72b458082146f6a08b462c09fa1b087f | |
| parent | mgr/cephadm: add empty line after param list in docstring (diff) | |
| download | ceph-8891d653198c30f9578499126e1ee9ee67eca04a.tar.xz ceph-8891d653198c30f9578499126e1ee9ee67eca04a.zip | |
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 <tchaikov@gmail.com>
| -rw-r--r-- | doc/conf.py | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/conf.py b/doc/conf.py index 79f32d24760..71d24d61104 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -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 |