Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #206

Open
khaledhosny opened this issue Sep 15, 2024 · 1 comment · May be fixed by #212
Open

Documentation #206

khaledhosny opened this issue Sep 15, 2024 · 1 comment · May be fixed by #212
Labels
help wanted Extra attention is needed

Comments

@khaledhosny
Copy link
Collaborator

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 khaledhosny added the help wanted Extra attention is needed label Sep 15, 2024
@madig
Copy link
Collaborator

madig commented Sep 16, 2024

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.

@Hoolean Hoolean linked a pull request Sep 22, 2024 that will close this issue
@khaledhosny khaledhosny linked a pull request Sep 24, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants