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

Consider adding Cython-based enum to the Sphinx documentation #555

Open
kingcrimsontianyu opened this issue Nov 15, 2024 · 0 comments
Open
Labels
feature request New feature or request python Affects the Python API of KvikIO

Comments

@kingcrimsontianyu
Copy link
Contributor

A new C++ enum kvikio::CompatMode will be exposed to Python API using Cython as of PR 547. However, Sphinx does not seem to be capable of processing the Cython code automatically, leaving this enum undocumented.

We may follow @wence- 's workaround initially devised for cuDF to generate Cython enum documentation for KvikIO.

@kingcrimsontianyu kingcrimsontianyu added feature request New feature or request python Affects the Python API of KvikIO labels Nov 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request New feature or request python Affects the Python API of KvikIO
Projects
None yet
Development

No branches or pull requests

1 participant