hpyproject / hpy

HPy: a better API for Python
https://hpyproject.org
MIT License
1.02k stars 52 forks source link

Put hyperlink to API reference into readme and improve autogen of API mapping table. #425

Closed fangerer closed 1 year ago

fangerer commented 1 year ago

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\n and .. 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(file hpy/tools/autogen/conf.py).