Skip to content

Commit 8fb3819

Browse files
committed
fix docs build
1 parent 65b760e commit 8fb3819

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

noxfile.py

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,20 @@ def docs(session):
217217
"""Build the docs for this library."""
218218

219219
session.install("-e", ".[grpc]")
220-
session.install("sphinx==4.2.0", "alabaster", "recommonmark")
220+
session.install(
221+
# We need to pin to specific versions of the `sphinxcontrib-*` packages
222+
# which still support sphinx 4.x.
223+
# See https://github.com/googleapis/sphinx-docfx-yaml/issues/344
224+
# and https://github.com/googleapis/sphinx-docfx-yaml/issues/345.
225+
"sphinxcontrib-applehelp==1.0.4",
226+
"sphinxcontrib-devhelp==1.0.2",
227+
"sphinxcontrib-htmlhelp==2.0.1",
228+
"sphinxcontrib-qthelp==1.0.3",
229+
"sphinxcontrib-serializinghtml==1.1.5",
230+
"sphinx==4.5.0",
231+
"alabaster",
232+
"recommonmark",
233+
)
221234

222235
shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True)
223236
session.run(
@@ -240,7 +253,18 @@ def docfx(session):
240253

241254
session.install("-e", ".")
242255
session.install(
243-
"sphinx==4.0.1", "alabaster", "recommonmark", "gcp-sphinx-docfx-yaml"
256+
# We need to pin to specific versions of the `sphinxcontrib-*` packages
257+
# which still support sphinx 4.x.
258+
# See https://github.com/googleapis/sphinx-docfx-yaml/issues/344
259+
# and https://github.com/googleapis/sphinx-docfx-yaml/issues/345.
260+
"sphinxcontrib-applehelp==1.0.4",
261+
"sphinxcontrib-devhelp==1.0.2",
262+
"sphinxcontrib-htmlhelp==2.0.1",
263+
"sphinxcontrib-qthelp==1.0.3",
264+
"sphinxcontrib-serializinghtml==1.1.5",
265+
"gcp-sphinx-docfx-yaml",
266+
"alabaster",
267+
"recommonmark",
244268
)
245269

246270
shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True)

0 commit comments

Comments
 (0)