Skip to content

Commit

Permalink
docs: Ensure all headers are parsed by Doxygen (#681)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
paleolimbot authored Nov 12, 2024
1 parent ea13185 commit b2f8d7e
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion python/src/nanoarrow/array.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
----------
Expand Down
2 changes: 1 addition & 1 deletion src/apidoc/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ FILE_PATTERNS = *.c \
*.ucf \
*.qsf \
*.ice
RECURSIVE = NO
RECURSIVE = YES
EXCLUDE =
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
Expand Down

0 comments on commit b2f8d7e

Please sign in to comment.