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 request: linkcheck #11472

Open
nstarman opened this issue May 19, 2024 · 3 comments
Open

Feature request: linkcheck #11472

nstarman opened this issue May 19, 2024 · 3 comments
Labels
rule Implementing or modifying a lint rule

Comments

@nstarman
Copy link

nstarman commented May 19, 2024

I'm not sure if this is out of scope for ruff, but it would be awesome to have a means to auto-fix links that now redirect.
Like many repos, we at Astropy use Sphinx's link checker to ensure links are working. They are, but our logs are chock full of warning about link redirects. No one has the bandwidth to manually fix them all, so it would be great if a CI tool could do this automatically! Even if a ruff-based fix was implemented only for Python docstrings, it would be immensely useful.

@augustelalande
Copy link
Contributor

Probably out of scope, since the only way to check it would be to actually lookup the link, which would be timely.

@nstarman
Copy link
Author

If it's out of scope for ruff, does anyone know of a tool that might accomplish this?

@santacodes
Copy link

If it's out of scope for ruff, does anyone know of a tool that might accomplish this?

I think you should check out lychee. It can integrate with CI as well, but I am not sure if it auto-fixes links.

@MichaReiser MichaReiser added the rule Implementing or modifying a lint rule label May 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
rule Implementing or modifying a lint rule
Projects
None yet
Development

No branches or pull requests

4 participants