Add Doxygen-to-Python docstring generation and update module documentation - #260
Open
jaycedowell wants to merge 12 commits into
Open
Add Doxygen-to-Python docstring generation and update module documentation#260jaycedowell wants to merge 12 commits into
jaycedowell wants to merge 12 commits into
Conversation
…ation. This adds a build step that extracts documentation from C header Doxygen comments and generates Python docstrings for the ctypes function wrappers. The docstrings are applied at runtime when bifrost.libbifrost is imported, making help() useful for the low-level API functions. Also updates docstrings across Python modules and blocks, and adds Doxygen documentation to C headers. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #260 +/- ##
==========================================
- Coverage 67.10% 67.03% -0.08%
==========================================
Files 67 67
Lines 6001 6012 +11
==========================================
+ Hits 4027 4030 +3
- Misses 1974 1982 +8
🚀 New features to boost your workflow:
|
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Add bifrost-config script that reports build configuration for external extensions, including compiler flags, include/library paths, and CUDA settings. Update tutorial 8 to document the external extension workflow as the recommended approach for C/C++ extensions. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This adds a build step that extracts documentation from C header Doxygen comments and generates Python docstrings for the ctypes function wrappers. The docstrings are applied at runtime when bifrost.libbifrost is imported, making help() useful for the low-level API functions.
Also updates docstrings across Python modules and blocks, and adds Doxygen documentation to C headers.