Skip to content

Commit 918ebcd

Browse files
authored
[Infra] Update doc configuration to ignore check from certain files (#37)
1 parent d5883a8 commit 918ebcd

File tree

3 files changed

+7
-4
lines changed

3 files changed

+7
-4
lines changed

docs/.readthedocs.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ version: 2
77

88
# Set the version of Python and other tools you might need
99
build:
10-
os: ubuntu-22.04
10+
os: ubuntu-24.04
1111
apt_packages:
1212
- git-lfs
13-
- libxkbcommon-dev
13+
- libxkbcommon-dev # YARF deps require xkbcommon>=1.4.1, Ubuntu-22.04 only has 1.4.0
1414
tools:
1515
python: "3.12"
1616
jobs:

docs/.sphinx/pa11y.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,8 @@
55
]
66
},
77
"reporter": "cli",
8-
"standard": "WCAG2AA"
8+
"standard": "WCAG2AA",
9+
"hideElements": [
10+
"div.highlight pre"
11+
]
912
}

docs/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ vale: vale-install
145145
@cat $(SPHINXDIR)/styles/config/vocabularies/Canonical/accept.txt > $(SPHINXDIR)/styles/config/vocabularies/Canonical/accept_backup.txt
146146
@cat $(SOURCEDIR)/.custom_wordlist.txt >> $(SPHINXDIR)/styles/config/vocabularies/Canonical/accept.txt
147147
@echo "Running Vale against $(TARGET). To change target set TARGET= with make command"
148-
@. $(VENV); vale --config="$(VALE_CONFIG)" --filter='$(SPHINXDIR)/styles/error.filter' --glob='*.{md,rst}' $(TARGET)
148+
@. $(VENV); vale --config="$(VALE_CONFIG)" --filter='$(SPHINXDIR)/styles/error.filter' --glob='*.{md,rst}' --glob='!reference/rf_libraries/**' $(TARGET)
149149
@cat $(SPHINXDIR)/styles/config/vocabularies/Canonical/accept_backup.txt > $(SPHINXDIR)/styles/config/vocabularies/Canonical/accept.txt && rm $(SPHINXDIR)/styles/config/vocabularies/Canonical/accept_backup.txt
150150

151151
spelling: vale-install

0 commit comments

Comments
 (0)