uharfbuzz icon indicating copy to clipboard operation
uharfbuzz copied to clipboard

Documentation

Open khaledhosny opened this issue 1 year ago • 1 comments

We don’t seem to have documentation anywhere, but we should. Even though we try to remain close to HarfBuzz C-API as much as possible, it is still non 1:1 and I often find myself looking into the source code to find the right API to use.

I don’t know what options we have for documenting Cython code, so opening this in case someone have an idea.

khaledhosny avatar Sep 15 '24 11:09 khaledhosny

I think Sphinx should be able to deal with Cython stuff as well. https://stackoverflow.com/questions/10057476/how-do-i-use-sphinx-with-cython says you may need to build the extension in place so that Sphinx can load and inspect it.

madig avatar Sep 16 '24 09:09 madig