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

Provide a way to suppress some warnings #104

Open
felix-hilden opened this issue Feb 3, 2022 · 2 comments
Open

Provide a way to suppress some warnings #104

felix-hilden opened this issue Feb 3, 2022 · 2 comments
Labels
enhancement New feature or request

Comments

@felix-hilden
Copy link
Owner

From #103: it could be annoying to deal with e.g. missing inventory warnings when a package and its documentation is out of your reach. But having warnings is still beneficial. I can see a couple of options that we could consider:

  • Provide a directive for suppressing warnings in a specific code example: this would mask other warnings in that code example though.
  • Provide configuration to disable extra warnings on intersphinx packages: this will surely mask lots of other warnings as well, and doesn't address the fact that you might not want to define a ref for each local module that can be imported.

Any other options? Personally I don't much care for either, but if I had to pick one it would be suppressing specific examples. At least that way people know that they might have problems and have more manual control over it.

@felix-hilden
Copy link
Owner Author

A list of modules or prefixes for inventory items could work. So specifying library.foo would disable inventory warnings for either just that entry or alternatively everything under it.

@felix-hilden
Copy link
Owner Author

Still not sure if it's worth to do this, but if we do, we might as well let the items be regexes so that people can disable exactly what they want and the logic on our end is simple.

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

No branches or pull requests

1 participant