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

Linkcheck: Fix broken url not reporting error #8323

Merged
merged 1 commit into from Oct 25, 2020

Conversation

TheTripleV
Copy link
Contributor

Subject: Linkcheck: Fix broken url not reporting error

Feature or Bugfix

  • Bugfix

Purpose

Some links are printed as broken but do not error out the build.
This issue appeared when we include tel: links in our build.

Relates

Some links are printed as broken but do not error out the build.

This issue appeared when include `tel:` links in our build.
@tk0miya
Copy link
Member

tk0miya commented Oct 24, 2020

I think tel: hyperlink should not be treated as an error in linkcheck. But it seems your PR treated them as errors. Is this expected?

@tk0miya
Copy link
Member

tk0miya commented Oct 24, 2020

Note: I just made a PR #8332 to make tel: links ignored.

@tk0miya tk0miya added this to the 3.3.0 milestone Oct 24, 2020
@TheTripleV
Copy link
Contributor Author

This PR only addresses the issue where unknown schemas are reported as broken by linkcheck but do not fail the sphinx build.

Here is a CI run showing the issue:

  1. linkcheck does not recognize the tel: schema and prints out (broken)
    https://github.com/wpilibsuite/frc-docs/runs/1276228243#step:6:601

  2. The build still succeeds (even though it shouldn't)
    https://github.com/wpilibsuite/frc-docs/runs/1276228243#step:6:752

@tk0miya
Copy link
Member

tk0miya commented Oct 25, 2020

Okay, I understand. It would be better to merge this to handle an error by unknown schema. Additionally, it would be better to suppress the error of tel schema.

@tk0miya tk0miya merged commit 2118ff1 into sphinx-doc:3.2.x Oct 25, 2020
@tk0miya
Copy link
Member

tk0miya commented Oct 25, 2020

Merged. Thank you for your contribution!

tk0miya added a commit that referenced this pull request Oct 25, 2020
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 22, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants