Add docs checks to GH workflows:
* spellcheck * linkcheck * inclusive-language check
This commit is contained in:
parent
4f1b2ccca2
commit
dd24762954
|
@ -0,0 +1,22 @@
|
||||||
|
name: Main Documentation Checks
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
paths:
|
||||||
|
- 'doc/**'
|
||||||
|
push:
|
||||||
|
paths:
|
||||||
|
- 'doc/**'
|
||||||
|
workflow_dispatch:
|
||||||
|
paths:
|
||||||
|
- 'doc/**'
|
||||||
|
|
||||||
|
concurrency:
|
||||||
|
group: ${{ github.workflow }}-${{ github.ref }}
|
||||||
|
cancel-in-progress: true
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
documentation-checks:
|
||||||
|
uses: canonical/documentation-workflows/.github/workflows/documentation-checks.yaml@main
|
||||||
|
with:
|
||||||
|
working-directory: 'doc'
|
|
@ -55,7 +55,7 @@ linkcheck:
|
||||||
. $(VENV) ; $(SPHINXBUILD) -c . -b linkcheck "$(SOURCEDIR)" "$(BUILDDIR)"
|
. $(VENV) ; $(SPHINXBUILD) -c . -b linkcheck "$(SOURCEDIR)" "$(BUILDDIR)"
|
||||||
|
|
||||||
woke:
|
woke:
|
||||||
type woke >/dev/null 2>&1 || { sudo snap install woke; exit 1; }
|
type woke >/dev/null 2>&1 || { sudo snap install woke || exit 1; }
|
||||||
woke *.rst **/*.rst -c https://github.com/canonical-web-and-design/Inclusive-naming/raw/main/config.yml
|
woke *.rst **/*.rst -c https://github.com/canonical-web-and-design/Inclusive-naming/raw/main/config.yml
|
||||||
|
|
||||||
.PHONY: help Makefile
|
.PHONY: help Makefile
|
||||||
|
|
Loading…
Reference in New Issue