This is an automated email from the ASF dual-hosted git repository.
paleolimbot pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-nanoarrow.git
The following commit(s) were added to refs/heads/main by this push:
new b2f8d7e0 docs: Ensure all headers are parsed by Doxygen (#681)
b2f8d7e0 is described below
commit b2f8d7e007a1116296c4202fc6fd3cf5501f85f0
Author: Dewey Dunnington <de...@dunnington.ca>
AuthorDate: Tue Nov 12 18:43:44 2024 +0000
docs: Ensure all headers are parsed by Doxygen (#681)
Because we had moved some headers outside of src/nanoarrow into
src/nanoarrow/common, they weren't getting included in the
documentation!
We can't quite add `-W` to the sphinx build command (error for warnings)
because pandoc doesn't generate .rst files that are warning free (and we
use pandoc to avoid having to write tutorials in restructured text).
Closes #676.
---
python/src/nanoarrow/array.py | 2 +-
src/apidoc/Doxyfile | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/python/src/nanoarrow/array.py b/python/src/nanoarrow/array.py
index 35ca7c68..25fc2eb0 100644
--- a/python/src/nanoarrow/array.py
+++ b/python/src/nanoarrow/array.py
@@ -116,7 +116,7 @@ class Array(ArrayViewVisitable):
the Arrow C Stream interface.
Note that an :class:`Array` is not necessarily contiguous in memory (i.e.,
- it may consist of zero or more ``ArrowArray``s).
+ it may consist of zero or more ``ArrowArray`` objects).
Parameters
----------
diff --git a/src/apidoc/Doxyfile b/src/apidoc/Doxyfile
index 129dd371..5a7471d0 100644
--- a/src/apidoc/Doxyfile
+++ b/src/apidoc/Doxyfile
@@ -187,7 +187,7 @@ FILE_PATTERNS = *.c \
*.ucf \
*.qsf \
*.ice
-RECURSIVE = NO
+RECURSIVE = YES
EXCLUDE =
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
