Skip to content

fix: Add quiet flag to linkchecker #536

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.

Sign up for GitHub

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

Merged
nhennigan merged 2 commits into from
Feb 20, 2026
Merged

fix: Add quiet flag to linkchecker #536

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
64c7a36
Add quiet flag to linkchecker
nhennigan Feb 19, 2026
0364365
Add changelog entry
nhennigan Feb 19, 2026
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
3 changes: 2 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
* Rename `TARGET` variable for Vale checks to `CHECK_PATH`.
* Remove or replace docs use of archived example product documentation site.
* Revert the switch to a reusable `automatic-doc-checks.yml` workflow.
* Add `-q` flag to linkchecker to only report errors or broken links.

### Changed

Expand All @@ -17,7 +18,7 @@
* `docs/reference/myst-syntax-reference.md` [#502](https://github.com/canonical/sphinx-docs-starter-pack/pull/502)
* `docs/reference/rst-syntax-reference.rst` [#502](https://github.com/canonical/sphinx-docs-starter-pack/pull/502)
* `.github/workflows/automatic-doc-checks.yml` [#514](https://github.com/canonical/sphinx-docs-starter-pack/pull/514)

* `docs/Makefile` [#536](https://github.com/canonical/sphinx-docs-starter-pack/pull/536)

## 1.4.1

Expand Down
2 changes: 1 addition & 1 deletion docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ clean-doc:
rm -rf $(SPHINX_DIR)/.doctrees

linkcheck: install
. $(DOCS_VENV) ; $(SPHINX_BUILD) -b linkcheck "$(DOCS_SOURCEDIR)" "$(DOCS_BUILDDIR)" $(SPHINX_OPTS) || { grep --color -F "[broken]" "$(DOCS_BUILDDIR)/output.txt"; exit 1; }
. $(DOCS_VENV) ; $(SPHINX_BUILD) -b linkcheck -q "$(DOCS_SOURCEDIR)" "$(DOCS_BUILDDIR)" $(SPHINX_OPTS) || { grep --color -F "[broken]" "$(DOCS_BUILDDIR)/output.txt"; exit 1; }
exit 0

pa11y: pa11y-install html
Expand Down
Loading