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

Commit 45cb84f

Browse files
build(python): fix docs and docfx builds (#195)
* 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 * See googleapis/synthtool#1916 --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Anthonios Partheniou <[email protected]>
1 parent f5459d5 commit 45cb84f

File tree

3 files changed

+29
-7
lines changed

3 files changed

+29
-7
lines changed

.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:2f155882785883336b4468d5218db737bb1d10c9cea7cb62219ad16fe248c03c
17-
# created: 2023-11-29T14:54:29.548172703Z
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: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,20 @@ def docs(session):
327327
"""Build the docs for this library."""
328328

329329
session.install("-e", ".")
330-
session.install("sphinx==4.0.1", "alabaster", "recommonmark")
330+
session.install(
331+
# We need to pin to specific versions of the `sphinxcontrib-*` packages
332+
# which still support sphinx 4.x.
333+
# See https://github.com/googleapis/sphinx-docfx-yaml/issues/344
334+
# and https://github.com/googleapis/sphinx-docfx-yaml/issues/345.
335+
"sphinxcontrib-applehelp==1.0.4",
336+
"sphinxcontrib-devhelp==1.0.2",
337+
"sphinxcontrib-htmlhelp==2.0.1",
338+
"sphinxcontrib-qthelp==1.0.3",
339+
"sphinxcontrib-serializinghtml==1.1.5",
340+
"sphinx==4.5.0",
341+
"alabaster",
342+
"recommonmark",
343+
)
331344

332345
shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True)
333346
session.run(
@@ -350,6 +363,15 @@ def docfx(session):
350363

351364
session.install("-e", ".")
352365
session.install(
366+
# We need to pin to specific versions of the `sphinxcontrib-*` packages
367+
# which still support sphinx 4.x.
368+
# See https://github.com/googleapis/sphinx-docfx-yaml/issues/344
369+
# and https://github.com/googleapis/sphinx-docfx-yaml/issues/345.
370+
"sphinxcontrib-applehelp==1.0.4",
371+
"sphinxcontrib-devhelp==1.0.2",
372+
"sphinxcontrib-htmlhelp==2.0.1",
373+
"sphinxcontrib-qthelp==1.0.3",
374+
"sphinxcontrib-serializinghtml==1.1.5",
353375
"gcp-sphinx-docfx-yaml",
354376
"alabaster",
355377
"recommonmark",

0 commit comments

Comments
 (0)