Skip to content

Commit 733cbd1

Browse files
committed
🚑 Reset version in Sphinx while spellchecking
1 parent ede56f4 commit 733cbd1

2 files changed

Lines changed: 6 additions & 4 deletions

File tree

docs/spelling_stub_ext.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,12 @@ def _skip(self, word: str) -> bool:
4848

4949
return True
5050

51+
# Resetting the release and version strings works around problems
52+
# with `setuptools-scm` generated versions being tokenized
53+
# by the spell checker incorrectly.
54+
app.config.release = 'dummy'
55+
app.config.version = 'dummy'
56+
5157
app.config.spelling_filters = [VersionFilter]
5258
app.setup_extension('sphinxcontrib.spelling')
5359

docs/spelling_wordlist.txt

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@ AppVeyor
22
Args
33
backend
44
backports
5-
bc
6-
bca
75
bugfixes
86
builtin
97
b'xb
@@ -15,15 +13,13 @@ chunked
1513
dev
1614
docstrings
1715
downstreams
18-
ef
1916
environ
2017
errored
2118
Faux
2219
fd
2320
Fortran
2421
hardcoded
2522
hostname
26-
gb
2723
inclusivity
2824
iterable
2925
linter

0 commit comments

Comments
 (0)