Skip to content

Commit f18354d

Browse files
authored
1 parent 453e59c commit f18354d

File tree

1 file changed

+28
-2
lines changed

1 file changed

+28
-2
lines changed

noxfile.py

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,20 @@ def docs(session):
123123

124124
session.install(".", "grpcio >= 1.8.2", "grpcio-gcp >= 0.2.2")
125125
session.install("-e", ".")
126-
session.install("sphinx==4.0.1", "alabaster", "recommonmark")
126+
session.install(
127+
# We need to pin to specific versions of the `sphinxcontrib-*` packages
128+
# which still support sphinx 4.x.
129+
# See https://github.com/googleapis/sphinx-docfx-yaml/issues/344
130+
# and https://github.com/googleapis/sphinx-docfx-yaml/issues/345.
131+
"sphinxcontrib-applehelp==1.0.4",
132+
"sphinxcontrib-devhelp==1.0.2",
133+
"sphinxcontrib-htmlhelp==2.0.1",
134+
"sphinxcontrib-qthelp==1.0.3",
135+
"sphinxcontrib-serializinghtml==1.1.5",
136+
"sphinx==4.5.0",
137+
"alabaster",
138+
"recommonmark",
139+
)
127140

128141
shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True)
129142
session.run(
@@ -145,7 +158,20 @@ def docfx(session):
145158
"""Build the docfx yaml files for this library."""
146159

147160
session.install("-e", ".")
148-
session.install("gcp-sphinx-docfx-yaml", "alabaster", "recommonmark")
161+
session.install(
162+
# We need to pin to specific versions of the `sphinxcontrib-*` packages
163+
# which still support sphinx 4.x.
164+
# See https://github.com/googleapis/sphinx-docfx-yaml/issues/344
165+
# and https://github.com/googleapis/sphinx-docfx-yaml/issues/345.
166+
"sphinxcontrib-applehelp==1.0.4",
167+
"sphinxcontrib-devhelp==1.0.2",
168+
"sphinxcontrib-htmlhelp==2.0.1",
169+
"sphinxcontrib-qthelp==1.0.3",
170+
"sphinxcontrib-serializinghtml==1.1.5",
171+
"gcp-sphinx-docfx-yaml",
172+
"alabaster",
173+
"recommonmark",
174+
)
149175

150176
shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True)
151177
session.run(

0 commit comments

Comments
 (0)