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

Replace autodoc with autoapi when generating Python docs via cmake #2077

Open
kontura opened this issue Feb 19, 2025 · 0 comments
Open

Replace autodoc with autoapi when generating Python docs via cmake #2077

kontura opened this issue Feb 19, 2025 · 0 comments

Comments

@kontura
Copy link
Contributor

kontura commented Feb 19, 2025

We use autoapi in readthedocs because it can parse code directly (code generated by swig) to access doc strings. The benefit is that we don't need to do a full build of the library to create working libdnf5 Python module which is required by autodoc to get doc strings.

We couldn't use autoapi in our regular cmake builds because it was not packaged in fedora (this was not a problem because regular builds have access to the full working Python module and can use autodoc) but autoapi is present since F41 in python-sphinx-autoapi package.

It would be nice to unify the workflows and simplify code by using only autoapi.
There should be no change in functionality.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant