Skip to content

Commit c0cf2ad

Browse files
committed
build(docs): re-enable docs packages we couldn't install
1 parent 8cf5b2b commit c0cf2ad

File tree

3 files changed

+15
-6
lines changed

3 files changed

+15
-6
lines changed

Makefile

+5-1
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,9 @@ _upgrade:
117117

118118
doc_upgrade: export CUSTOM_COMPILE_COMMAND=make doc_upgrade
119119
doc_upgrade: $(DOCBIN) ## Update the doc/requirements.pip file
120+
@# I don't understand why, but pip-tools won't update versions in this
121+
@# .pip file unless I remove it first:
122+
rm doc/requirements.pip
120123
$(DOCBIN)/pip install -q -r requirements/pip-tools.pip
121124
$(DOCBIN)/$(PIP_COMPILE) -o doc/requirements.pip doc/requirements.in
122125

@@ -254,7 +257,8 @@ docdev: dochtml ## Build docs, and auto-watch for changes.
254257
PATH=$(DOCBIN):$(PATH) $(SPHINXAUTOBUILD) -b html doc doc/_build/html
255258

256259
docspell: $(DOCBIN) ## Run the spell checker on the docs.
257-
$(SPHINXBUILD) -b spelling doc doc/_spell
260+
# Very mac-specific...
261+
PYENCHANT_LIBRARY_PATH=/opt/homebrew/lib/libenchant-2.dylib $(SPHINXBUILD) -b spelling doc doc/_spell
258262

259263

260264
##@ Publishing docs

doc/requirements.in

+3-5
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,12 @@
77
-c ../requirements/pins.pip
88

99
cogapp
10+
doc8
11+
pyenchant
1012
scriv # for writing GitHub releases
1113
sphinx
1214
sphinx-autobuild
1315
sphinx_rtd_theme
1416
sphinx-code-tabs
1517
sphinxcontrib-restbuilder
16-
17-
# These aren't compatible atm with other library versions:
18-
doc8
19-
#pyenchant
20-
#sphinxcontrib-spelling
18+
sphinxcontrib-spelling

doc/requirements.pip

+7
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,10 @@ packaging==23.2
5252
# via sphinx
5353
pbr==6.0.0
5454
# via stevedore
55+
pyenchant==3.2.2
56+
# via
57+
# -r doc/requirements.in
58+
# sphinxcontrib-spelling
5559
pygments==2.17.2
5660
# via
5761
# doc8
@@ -76,6 +80,7 @@ sphinx==7.2.6
7680
# sphinx-rtd-theme
7781
# sphinxcontrib-jquery
7882
# sphinxcontrib-restbuilder
83+
# sphinxcontrib-spelling
7984
sphinx-autobuild==2024.2.4
8085
# via -r doc/requirements.in
8186
sphinx-code-tabs==0.5.5
@@ -98,6 +103,8 @@ sphinxcontrib-restbuilder==0.3
98103
# via -r doc/requirements.in
99104
sphinxcontrib-serializinghtml==1.1.10
100105
# via sphinx
106+
sphinxcontrib-spelling==8.0.0
107+
# via -r doc/requirements.in
101108
stevedore==5.2.0
102109
# via doc8
103110
tornado==6.4

0 commit comments

Comments
 (0)