Create broken-linkcheck.yml

[ggold7046]

Created a Github Action to run the Sphinx linkcheck monthly.

• closes #xxxx (Replace xxxx with the GitHub issue number) DOC/CI: Add Github Action cron job to check external links in documentation #45409
• Tests added and passed if fixing a bug or adding a new feature
• All code checks passed.
• Added type annotations to new arguments/methods/functions.
• Added an entry in the latest doc/source/whatsnew/vX.X.X.rst file if fixing a bug or adding a new feature.

[mroeschke]

Could you make this workflow run in this PR to check the output?

[ggold7046]

Could you make this workflow run in this PR to check the output?

Could you tell me how to do that ? Do I need to change the yaml code ?

[mroeschke]

Yes see https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on or other workflows in this repo

[ggold7046]

I changed it to on: workflow_dispatch. But still I don't see any run workflow button . manually-running-a-workflow
Is it the proper way to run the workflow immediately ?

[ggold7046]

@pmeier could you see this please ?

[ggold7046]

Linkcheck failed . It says

File "/home/runner/work/pandas/pandas/doc/make.py", line 23, in <module>
    import docutils
ModuleNotFoundError: No module named 'docutils'

[pmeier]

Sorry, you also need to put

pandas/.github/workflows/docbuild-and-upload.yml

Lines 33 to 37 in 89bd569

	defaults:
	run:
	shell: bash -el {0}
	steps:

inside the workflow to automatically activate the conda env.

[ggold7046]

@pmeier , there are many broken links. How to fix them ?
The linkcheck is showing proper output , then why the ci is showing it as failure ?

[ggold7046]

@mroeschke , could you look into the pr if anything else to add?

[pmeier]

there are many broken links. How to fix them ?

Well, find the source that contains the broken link, and replace it with a working one.

The linkcheck is showing proper output , then why the ci is showing it as failure ?

The whole point of the linkcheck CI is to fail in case there are broken links. Meaning, this PR cannot be merged until the links are fixed.

Alternatively, sphinx-build linkcheck has options to ignore certain failures. You could also add ignores for all broken links for now and chip away at the ignore list later on. The options need to go into conf.py.

If I were you, I would probably write a small script to parse the output of the CI run, which you can download here, to automatically create the ignore list.

[ggold7046]

pre-commit.ci autofix

[ggold7046]

@mroeschke , I have worked on your suggestions, please let me know if there are other suggestion.

[ggold7046]

@pmeier, could you please look at this linkcheck fail ?

[pmeier]

@ggold7046 your patch resurfaces an issue we had before: #55246 (comment). Plus there seems to be a new broken link that needs to be ignored as well.

[ggold7046]

your patch resurfaces an issue we had before: #55246 (comment).

@pmeier , didn't we took care of it already ?

[pmeier]

Well, you "reverted" the patch by applying re.escape to everything in the ignore list again.

[ggold7046]

pre-commit.ci autofix

[ggold7046]

@mroeschke , could you take a look at this PR please ?

[mroeschke]

2 small comments otherwise LGTM

[mroeschke]

Thanks @ggold7046 and @pmeier for your patience and effort here