Skip to content

Commit 7cf4d85

Browse files
committed
Devops: Add --color option to linkcheck
This helps with spotting broken links in the output. Without the coloring it is difficult to sift through all the output. For the CI workflow, the `-q` flag is also added such that only broken links are printed for easy debugging.
1 parent 6c2b997 commit 7cf4d85

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,4 @@ jobs:
2424
pip install --upgrade pip
2525
pip install -rrequirements.txt
2626
- name: Run linkcheck
27-
run: sphinx-build -b linkcheck docs/ docs/_build/linkcheck
27+
run: sphinx-build -b linkcheck docs/ docs/_build/linkcheck --color -q

tox.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,4 @@ deps = -rrequirements.txt
2323
allowlist_externals =
2424
rm
2525
commands_pre = rm -rf docs/_build/htlinkcheckml
26-
commands = sphinx-build -b linkcheck docs/ docs/_build/linkcheck
26+
commands = sphinx-build -b linkcheck docs/ docs/_build/linkcheck --color

0 commit comments

Comments
 (0)