Skip to content

Commit

Permalink
Attempt to get docs CI to pass (#6377)
Browse files Browse the repository at this point in the history
Merging to unblock #6375
  • Loading branch information
stevepiercy authored Oct 5, 2024
1 parent b511084 commit 13d5fde
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 8 deletions.
12 changes: 5 additions & 7 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ on:
paths:
- 'docs/**'
- 'styles/**'
- '.github/workflows/docs.yml'
- 'requirements-docs.txt'
- '.vale.ini'

jobs:
docs:
Expand All @@ -31,9 +34,7 @@ jobs:
run: pip install virtualenv

- name: pip install requirements
run: |
pip install -r requirements-docs.txt
sudo snap install --edge vale
run: pip install -r requirements-docs.txt

- name: Check for broken links
run: make docs-linkcheckbroken
Expand All @@ -42,7 +43,4 @@ jobs:
run: make docs-html

- name: Run vale
run: |
git clone https://github.com/errata-ai/Microsoft.git
cp -r ./Microsoft/Microsoft ./styles
vale --no-exit ./docs
run: make docs-vale VALEOPTS=--no-exit
3 changes: 2 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ TESTING_ADDONS=plone.app.robotframework==2.0.0 plone.app.testing==7.0.0
# Sphinx variables
# You can set these variables from the command line.
SPHINXOPTS ?=
VALEOPTS ?=
# Internal variables.
SPHINXBUILD = $(realpath bin/sphinx-build)
SPHINXAUTOBUILD = $(realpath bin/sphinx-autobuild)
Expand Down Expand Up @@ -149,7 +150,7 @@ docs-linkcheckbroken: bin/python ## Run linkcheck and show only broken links
.PHONY: docs-vale
docs-vale: ## Run Vale style, grammar, and spell checks
vale sync
vale --no-wrap $(VALEFILES)
vale --no-wrap $(VALEOPTS) $(VALEFILES)
@echo
@echo "Vale is finished; look for any errors in the above output."

Expand Down
1 change: 1 addition & 0 deletions news/6377.documentation
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Install Vale via pip, and pin to <3.0.0, allowing it to run locally and in CI without reconfiguration. @stevepiercy
1 change: 1 addition & 0 deletions requirements-docs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,4 @@ sphinxcontrib-htmlhelp==2.0.1 # https://github.com/plone/documentation/issues/1
sphinxcontrib-qthelp==1.0.3 # https://github.com/plone/documentation/issues/1604
sphinxcontrib-serializinghtml==1.1.5 # https://github.com/plone/documentation/issues/1604
sphinxcontrib-video
vale<3.0.0

0 comments on commit 13d5fde

Please sign in to comment.