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

Autodocument llvmlite #972

Open
esc opened this issue Jul 11, 2023 · 0 comments
Open

Autodocument llvmlite #972

esc opened this issue Jul 11, 2023 · 0 comments
Labels
feature_request Feature Request

Comments

@esc
Copy link
Member

esc commented Jul 11, 2023


Feature request

Currently llvmlite isn't making use of the Sphinx autodoc feature, but instead the docs have been written verbatim into the git repository, for example:

https://github.com/numba/llvmlite/blob/main/docs/source/user-guide/ir/ir-builder.rst

The feature request is to check and replace all documentation with an autogenerated version that derives the documentation from the docstrings in the source code.

@esc esc added this to the v0.41.0rc1 milestone Jul 11, 2023
@esc esc added the feature_request Feature Request label Jul 11, 2023
@esc esc removed this from the v0.41.0rc1 milestone Jul 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature_request Feature Request
Projects
None yet
Development

No branches or pull requests

1 participant