Merge pull request #697 from ZettaScaleLabs/fix_bool_in_docs

Fix docs generation for methods which returns bool
eclipse-zenoh · Sep 30, 2024 · 4a56e63 · 4a56e63
2 parents c9d83d6 + 66656bb
commit 4a56e63
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -30,6 +30,7 @@
 language = 'c'
 c_autodoc_roots = ['../include/zenoh-pico/api/']
 c_autodoc_compilation_args = [
+    "-DSPHINX_DOCS",
     "-DZ_FEATURE_UNSTABLE_API=1",
     "-DZ_FEATURE_PUBLICATION=1",
     "-DZ_FEATURE_SUBSCRIPTION=1",

diff --git a/include/zenoh-pico/api/primitives.h b/include/zenoh-pico/api/primitives.h
@@ -15,7 +15,10 @@
 #ifndef INCLUDE_ZENOH_PICO_API_PRIMITIVES_H
 #define INCLUDE_ZENOH_PICO_API_PRIMITIVES_H
 
+#ifndef SPHINX_DOCS
+// For some reason sphinx/clang doesn't handle bool types correctly if stdbool.h is included
 #include <stdbool.h>
+#endif
 #include <stdint.h>
 
 #include "olv_macros.h"