-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
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
linkcheck option to ignore certain protocols #12915
Comments
Thanks for the feature request / bugreport! Do you expect to ignore additional URI schemes other than I'll also note that |
Would it make sense to just whitelist http and https? I'm not sure what other schemes we could reasonably expect to work... A |
This conf.py option works:
But it generates a message per link:
Maybe an option without the messages:
I first came across this many years ago in KDE's Konqueror documentation - Viewing Help, Man and Info Pages, but it also works in Firefox. I don't have a link for that, but this might help explain that a protocol handler can be added. Google-Chrome used
|
Is your feature request related to a problem? Please describe.
Run:
Produces an error for each
man:
, for example:conf.py has:
Markdown example:
HTML output:
Firefox browser has an application content type of
man
(x-scheme-handler/man), which is handled by an xdg desktop file to convert a local man page to html and display it in the browser.Describe the solution you'd like
An option added to
sphinx-build -b linkcheck source/ _build/linkcheck
to ignore specified protocols, like manpage url.Current options for the linkcheck builder.
Describe alternatives you've considered
An alternative is to pipe the output to
grep
and filter outman:
errors.The text was updated successfully, but these errors were encountered: