Put hyperlink to API reference into readme and improve autogen of API mapping table. #425
Conversation
This file contains 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
hodgestar
reviewed
Apr 18, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Should finally resolve #323 and also improves the auto-generation of the C API - HPy API function mapping table.
The table is now written into the document that contains it (currently
docs/porting-guide.rst). The new approach replaces everything between two markers (i.e... mark: BEGIN API MAPPING\nand.. mark: END API MAPPING\n).Previously, I manually merged an auto-generated part of the table with some manually defined mappings. This is now also done by autogen. Therefore, one needs to specify the manual mappings in dict
DOC_MANUAL_API_MAPPING(filehpy/tools/autogen/conf.py).