Skip to content
This repository was archived by the owner on Mar 9, 2026. It is now read-only.

Commit 0562d23

Browse files
gcf-owl-bot[bot]parthea
gcf-owl-bot[bot]
and
parthea
authored
build(python): fix docs and docfx builds (#1063)
* build(python): fix `docs` and `docfx` builds Source-Link: googleapis/synthtool@fac8444 Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5ea6d0ab82c956b50962f91d94e206d3921537ae5fe1549ec5326381d8905cfa * exclude types-protobuf==4.24.0.20240106 release * typo * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * exclude types-protobuf==4.24.0.20240106 release * update replacement * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Anthonios Partheniou <[email protected]>
1 parent 265f410 commit 0562d23

4 files changed

Lines changed: 37 additions & 15 deletions

File tree

‎.github/.OwlBot.lock.yaml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Copyright 2023 Google LLC
1+
# Copyright 2024 Google LLC
22
#
33
# Licensed under the Apache License, Version 2.0 (the "License");
44
# you may not use this file except in compliance with the License.
@@ -13,5 +13,5 @@
1313
# limitations under the License.
1414
docker:
1515
image: gcr.io/cloud-devrel-public-resources/owlbot-python:latest
16-
digest: sha256:346ab2efb51649c5dde7756cbbdc60dd394852ba83b9bbffc292a63549f33c17
17-
# created: 2023-12-14T22:17:57.611773021Z
16+
digest: sha256:5ea6d0ab82c956b50962f91d94e206d3921537ae5fe1549ec5326381d8905cfa
17+
# created: 2024-01-15T16:32:08.142785673Z

‎.kokoro/requirements.txt‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -263,9 +263,9 @@ jeepney==0.8.0 \
263263
# via
264264
# keyring
265265
# secretstorage
266-
jinja2==3.1.2 \
267-
--hash=sha256:31351a702a408a9e7595a8fc6150fc3f43bb6bf7e319770cbc0db9df9437e852 \
268-
--hash=sha256:6088930bfe239f0e6710546ab9c19c9ef35e29792895fed6e6e31a023a182a61
266+
jinja2==3.1.3 \
267+
--hash=sha256:7d6d50dd97d52cbc355597bd845fabfbac3f551e1f99619e39a35ce8c370b5fa \
268+
--hash=sha256:ac8bd6544d4bb2c9792bf3a159e80bba8fda7f07e81bc3aed565432d5925ba90
269269
# via gcp-releasetool
270270
keyring==24.2.0 \
271271
--hash=sha256:4901caaf597bfd3bbd78c9a0c7c4c29fcd8310dab2cffefe749e916b6527acd6 \

‎noxfile.py‎

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -92,17 +92,19 @@ def mypy(session):
9292
session.install("-e", ".[all]")
9393
session.install(MYPY_VERSION)
9494

95-
# Just install the type info directly, since "mypy --install-types" might
96-
# require an additional pass.
97-
session.install("types-protobuf", "types-setuptools")
98-
9995
# Version 2.1.1 of google-api-core version is the first type-checked release.
10096
# Version 2.2.0 of google-cloud-core version is the first type-checked release.
10197
session.install(
10298
"google-api-core[grpc]>=2.1.1",
10399
"google-cloud-core>=2.2.0",
104100
)
105101

102+
# Just install the type info directly, since "mypy --install-types" might
103+
# require an additional pass.
104+
# Exclude types-protobuf==4.24.0.20240106
105+
# See https://github.com/python/typeshed/issues/11254
106+
session.install("types-protobuf!=4.24.0.20240106", "types-setuptools")
107+
106108
# TODO: Only check the hand-written layer, the generated code does not pass
107109
# mypy checks yet.
108110
# https://github.com/googleapis/gapic-generator-python/issues/1092
@@ -334,7 +336,16 @@ def docs(session):
334336

335337
session.install("-e", ".")
336338
session.install(
337-
"sphinx==4.0.1",
339+
# We need to pin to specific versions of the `sphinxcontrib-*` packages
340+
# which still support sphinx 4.x.
341+
# See https://github.com/googleapis/sphinx-docfx-yaml/issues/344
342+
# and https://github.com/googleapis/sphinx-docfx-yaml/issues/345.
343+
"sphinxcontrib-applehelp==1.0.4",
344+
"sphinxcontrib-devhelp==1.0.2",
345+
"sphinxcontrib-htmlhelp==2.0.1",
346+
"sphinxcontrib-qthelp==1.0.3",
347+
"sphinxcontrib-serializinghtml==1.1.5",
348+
"sphinx==4.5.0",
338349
"alabaster",
339350
"recommonmark",
340351
)
@@ -360,6 +371,15 @@ def docfx(session):
360371

361372
session.install("-e", ".")
362373
session.install(
374+
# We need to pin to specific versions of the `sphinxcontrib-*` packages
375+
# which still support sphinx 4.x.
376+
# See https://github.com/googleapis/sphinx-docfx-yaml/issues/344
377+
# and https://github.com/googleapis/sphinx-docfx-yaml/issues/345.
378+
"sphinxcontrib-applehelp==1.0.4",
379+
"sphinxcontrib-devhelp==1.0.2",
380+
"sphinxcontrib-htmlhelp==2.0.1",
381+
"sphinxcontrib-qthelp==1.0.3",
382+
"sphinxcontrib-serializinghtml==1.1.5",
363383
"gcp-sphinx-docfx-yaml",
364384
"alabaster",
365385
"recommonmark",

‎owlbot.py‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -366,17 +366,19 @@ def mypy(session):
366366
session.install("-e", ".[all]")
367367
session.install(MYPY_VERSION)
368368
369-
# Just install the type info directly, since "mypy --install-types" might
370-
# require an additional pass.
371-
session.install("types-protobuf", "types-setuptools")
372-
373369
# Version 2.1.1 of google-api-core version is the first type-checked release.
374370
# Version 2.2.0 of google-cloud-core version is the first type-checked release.
375371
session.install(
376372
"google-api-core[grpc]>=2.1.1",
377373
"google-cloud-core>=2.2.0",
378374
)
379375
376+
# Just install the type info directly, since "mypy --install-types" might
377+
# require an additional pass.
378+
# Exclude types-protobuf==4.24.0.20240106
379+
# See https://github.com/python/typeshed/issues/11254
380+
session.install("types-protobuf!=4.24.0.20240106", "types-setuptools")
381+
380382
# TODO: Only check the hand-written layer, the generated code does not pass
381383
# mypy checks yet.
382384
# https://github.com/googleapis/gapic-generator-python/issues/1092

0 commit comments

Comments
 (0)