Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Ensure all headers are parsed by Doxygen #681

Merged
merged 3 commits into from
Nov 12, 2024

Conversation

paleolimbot
Copy link
Member

@paleolimbot paleolimbot commented Nov 12, 2024

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.

@paleolimbot paleolimbot marked this pull request as ready for review November 12, 2024 17:23
@paleolimbot paleolimbot merged commit b2f8d7e into apache:main Nov 12, 2024
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation: C API reference missing information
2 participants