DOC: Add how-to guide for extending the NumPy C API - #32784
Draft
BHUVANSH855 wants to merge 1 commit into
Draft
BHUVANSH855 wants to merge 1 commit into
BHUVANSH855 wants to merge 1 commit into
Conversation
BHUVANSH855
force-pushed
the
doc/howto-add-c-api
branch
from
September 24, 2026 19:11
5ce17c2 to
bbcd3f1
Compare
This branch has not been deployed
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
1 participant
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.
PR summary
There is no single place in the NumPy developer guide documenting the full workflow for adding or extending a public C-API entry point. Contributors have had to reverse-engineer the process from existing code and old PRs (see #30264).
This PR adds
doc/source/dev/howto-add-c-api.rst, a how-to guide covering:C_API_VERSION,MinVersion, ABI guards)cversions.pybookkeeping stepTwo small supporting edits:
doc/source/dev/index.rst— one toctree entry afterdevelopment_advanced_debuggingdoc/source/dev/reviewer_guidelines.rst— one cross-reference sentence in the API changes section pointing to the new guideCloses #30264
First time contributor introduction
I am a first-time contributor to this part of NumPy's documentation. I currently have one merged PR and two additional PRs open, and I wanted to contribute something concrete and well-researched to the developer documentation.
AI Disclosure
Claude is used to research the NumPy repository and git history and cross-check relevant source files and documentation details.