Skip to content

Commit fac8444

Browse files
authored
build(python): fix docs and docfx builds (#1916)
build(python): fix docs build
1 parent 78048ac commit fac8444

File tree

2 files changed

+37
-1
lines changed

2 files changed

+37
-1
lines changed

synthtool/gcp/templates/python_library/noxfile.py.j2

+19-1
Original file line numberDiff line numberDiff line change
@@ -350,7 +350,16 @@ def docs(session):
350350

351351
session.install("-e", ".")
352352
session.install(
353-
"sphinx==4.0.1",
353+
# We need to pin to specific versions of the `sphinxcontrib-*` packages
354+
# which still support sphinx 4.x.
355+
# See https://github.com/googleapis/sphinx-docfx-yaml/issues/344
356+
# and https://github.com/googleapis/sphinx-docfx-yaml/issues/345.
357+
"sphinxcontrib-applehelp==1.0.4",
358+
"sphinxcontrib-devhelp==1.0.2",
359+
"sphinxcontrib-htmlhelp==2.0.1",
360+
"sphinxcontrib-qthelp==1.0.3",
361+
"sphinxcontrib-serializinghtml==1.1.5",
362+
"sphinx==4.5.0",
354363
"alabaster",
355364
"recommonmark",
356365
)
@@ -376,6 +385,15 @@ def docfx(session):
376385

377386
session.install("-e", ".")
378387
session.install(
388+
# We need to pin to specific versions of the `sphinxcontrib-*` packages
389+
# which still support sphinx 4.x.
390+
# See https://github.com/googleapis/sphinx-docfx-yaml/issues/344
391+
# and https://github.com/googleapis/sphinx-docfx-yaml/issues/345.
392+
"sphinxcontrib-applehelp==1.0.4",
393+
"sphinxcontrib-devhelp==1.0.2",
394+
"sphinxcontrib-htmlhelp==2.0.1",
395+
"sphinxcontrib-qthelp==1.0.3",
396+
"sphinxcontrib-serializinghtml==1.1.5",
379397
"gcp-sphinx-docfx-yaml",
380398
"alabaster",
381399
"recommonmark",

synthtool/gcp/templates/python_mono_repo_library/noxfile.py.j2

+18
Original file line numberDiff line numberDiff line change
@@ -359,6 +359,15 @@ def docs(session):
359359

360360
session.install("-e", ".")
361361
session.install(
362+
# We need to pin to specific versions of the `sphinxcontrib-*` packages
363+
# which still support sphinx 4.x.
364+
# See https://github.com/googleapis/sphinx-docfx-yaml/issues/344
365+
# and https://github.com/googleapis/sphinx-docfx-yaml/issues/345.
366+
"sphinxcontrib-applehelp==1.0.4",
367+
"sphinxcontrib-devhelp==1.0.2",
368+
"sphinxcontrib-htmlhelp==2.0.1",
369+
"sphinxcontrib-qthelp==1.0.3",
370+
"sphinxcontrib-serializinghtml==1.1.5",
362371
"sphinx==4.5.0",
363372
"alabaster",
364373
"recommonmark",
@@ -385,6 +394,15 @@ def docfx(session):
385394

386395
session.install("-e", ".")
387396
session.install(
397+
# We need to pin to specific versions of the `sphinxcontrib-*` packages
398+
# which still support sphinx 4.x.
399+
# See https://github.com/googleapis/sphinx-docfx-yaml/issues/344
400+
# and https://github.com/googleapis/sphinx-docfx-yaml/issues/345.
401+
"sphinxcontrib-applehelp==1.0.4",
402+
"sphinxcontrib-devhelp==1.0.2",
403+
"sphinxcontrib-htmlhelp==2.0.1",
404+
"sphinxcontrib-qthelp==1.0.3",
405+
"sphinxcontrib-serializinghtml==1.1.5",
388406
"gcp-sphinx-docfx-yaml",
389407
"alabaster",
390408
"recommonmark",

0 commit comments

Comments
 (0)