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

FEATURE: intersphinx--emit message during build for each objects.inv data line skipped due to regex mismatch #8825

Open
bskinn opened this issue Feb 4, 2021 · 0 comments

Comments

@bskinn
Copy link
Contributor

bskinn commented Feb 4, 2021

Is your feature request related to a problem? Please describe.
This feature request is not directly related to a specific problem I'm experiencing, but it could potentially help users in debugging why an intersphinx cross-reference isn't working. The idea for this occurred to me in the course of thinking about how to handle a missing uri field from the perspective of my project for inspecting/manipulating objects.inv files, bskinn/sphobjinv.

Describe the solution you'd like
Currently, during docs build, if a line in a decompressed objects.inv does not match the regex used to parse for name, domain, etc. it is simply ignored. It would potentially be useful to have Sphinx emit an INFO message for these lines instead of silently ignoring them.

I think an INFO level message would be preferred, since implementing as a WARNING would cause difficult-to-fix breakage for anyone running with the -W flag. (They would not be able to quickly fix an objects.inv published in third-party documentation.) I think it should be easier to implement, too, since it wouldn't(?) have to be tied back into Sphinx's warning/error tracking mechanisms.

Describe alternatives you've considered
I can't think of any alternatives in terms of notifying the user during a documentation build. Other tools (e.g., sphobjinv) could implement such checking, but users would have to know to use a separate tool to discover these errors.

@bskinn bskinn added the type:enhancement enhance or introduce a new feature label Feb 4, 2021
@AA-Turner AA-Turner added this to the some future version milestone Sep 29, 2022
@AA-Turner AA-Turner added type:proposal a feature suggestion and removed type:enhancement enhance or introduce a new feature extensions labels Jan 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants