Skip to content
This repository was archived by the owner on Sep 24, 2025. It is now read-only.

Automate link checking#102

Merged
m3ller merged 1 commit intodwavesystems:masterfrom
JoelPasvolsky:checklinks
Apr 13, 2020
Merged

Automate link checking#102
m3ller merged 1 commit intodwavesystems:masterfrom
JoelPasvolsky:checklinks

Conversation

@JoelPasvolsky
Copy link
Copy Markdown
Contributor

Trial balloon: I used sphinx's linkcheck to find outdated links locally and am wondering whether I should add these to CircleCI. I'd first update all links in a repo, add the CircleCI test, and in the end add it to the SDK.
Let me know what you think.

@m3ller m3ller requested review from m3ller and randomir April 10, 2020 01:02
Comment thread .circleci/config.yml
name: linkcheck
command: |
. env/bin/activate
make -C docs/ linkcheck linkcheck_retries=3 linkcheck_anchors=False linkcheck_ignore=[https:\/\/codecov.*]
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you sure any of these options (linkcheck_retries, etc) actually propagate to sphinx-build?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No. I put them here as a reminder of what might need to be set in other repos but when I tried setting more than a single value for linkcheck_ignore I could not get it to work properly. I did not finish work on that yet. Here I put this for PR to get feedback on whether we want to add this testing before I spend much time getting it to work

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, I think we should definitely add some link checking. Maybe even make it a periodic job. But finishing this PR would be a great start.

@m3ller m3ller merged commit 8af4380 into dwavesystems:master Apr 13, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants