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 into from
Apr 13, 2020
Merged

Automate link checking #102

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions .circleci/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ jobs:
paths:
- ./env
key: v2-dependencies-{{ checksum "requirements.txt" }}-{{ .Environment.CIRCLE_JOB }}

- run: &run-tests-template
name: run unittests
command: |
Expand All @@ -50,6 +50,12 @@ jobs:
. env/bin/activate
make -C docs/ doctest

- run:
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

@randomir randomir Apr 13, 2020

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

@JoelPasvolsky JoelPasvolsky Apr 13, 2020

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

@randomir randomir Apr 13, 2020

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.


test-3.7:
<<: *full-test-template
docker:
Expand All @@ -74,10 +80,10 @@ jobs:

working_directory: ~/repo

steps:
steps:
- checkout

- run:
- run:
name: install pyenv
command: |
brew install pyenv
Expand Down Expand Up @@ -114,7 +120,7 @@ jobs:
paths:
- ./env
key: v2-dependencies-{{ checksum "requirements.txt" }}-{{ .Environment.CIRCLE_JOB }}

- run: *run-tests-template

test-osx-3.7:
Expand Down