Skip to content

Commit 6820222

Browse files
committed
Check the docs with a strict build
This treats warnings as errors.
1 parent ed6e83c commit 6820222

2 files changed

Lines changed: 5 additions & 2 deletions

File tree

.github/workflows/build_workflow.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ jobs:
114114
load_script=$(find . -maxdepth 1 -type f -name 'load_compass*.sh' | sort | tail -n 1)
115115
source "$load_script"
116116
cd docs
117-
make html
117+
make html-strict
118118
119119
- if: ${{ steps.skip_check.outputs.should_skip != 'true' }}
120120
name: Run Tests

docs/Makefile

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,10 @@ BUILDDIR = _build
1212
help:
1313
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
1414

15-
.PHONY: help Makefile
15+
.PHONY: help html-strict Makefile
16+
17+
html-strict:
18+
@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" -W $(SPHINXOPTS) $(O)
1619

1720
# Catch-all target: route all unknown targets to Sphinx using the new
1821
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).

0 commit comments

Comments
 (0)