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

coverage checking via autoapi (incompatibility with sphinx.ext.coverage) #509

Open
nyoma-diamond opened this issue Jan 16, 2025 · 0 comments

Comments

@nyoma-diamond
Copy link

I've found autoapi to be a great alternative to autodoc/autosummary since the program I'm developing relies on external software that must be running during operation, and as a result must launched when generating documentation via autodoc/autosummary. However, autoapi does not appear to have any coverage-checking functionality like sphinx.ext.coverage. Attempting to use sphinx.ext.coverage alongside autoapi does not appear to work. In any case even if it did, sphinx.ext.coverage also shares autodoc's problem of needing to import the relevant modules, and therefore has the associated side-effects (in my case, requiring that the external software be running).

Are there any plans to implement any form of coverage checking to mimic sphinx.ext.coverage?

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

No branches or pull requests

1 participant