Skip to content

Commit 1271b18

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
build(python): fix docs and docfx builds (#1779)
Source-Link: https://togithub.com/googleapis/synthtool/commit/fac8444edd5f5526e804c306b766a271772a3e2f Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5ea6d0ab82c956b50962f91d94e206d3921537ae5fe1549ec5326381d8905cfa
1 parent 0b5c1d5 commit 1271b18

File tree

4 files changed

+39
-112
lines changed

4 files changed

+39
-112
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 \

‎docs/reference.rst

Lines changed: 10 additions & 105 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
API Reference
22
~~~~~~~~~~~~~
33

4-
.. currentmodule:: google.cloud.bigquery
5-
64
The main concepts with this API are:
75

86
- :class:`~google.cloud.bigquery.client.Client` manages connections to the
@@ -18,55 +16,12 @@ The main concepts with this API are:
1816
Client
1917
======
2018

21-
.. autosummary::
22-
:toctree: generated
23-
24-
client.Client
19+
.. automodule:: google.cloud.bigquery.client
2520

2621
Job
2722
===
2823

29-
Job Configuration
30-
-----------------
31-
32-
.. autosummary::
33-
:toctree: generated
34-
35-
job.QueryJobConfig
36-
job.CopyJobConfig
37-
job.LoadJobConfig
38-
job.ExtractJobConfig
39-
40-
Job Classes
41-
-----------
42-
43-
.. autosummary::
44-
:toctree: generated
45-
46-
job.QueryJob
47-
job.CopyJob
48-
job.LoadJob
49-
job.ExtractJob
50-
51-
Job-Related Types
52-
-----------------
53-
54-
.. autosummary::
55-
:toctree: generated
56-
57-
job.Compression
58-
job.CreateDisposition
59-
job.DestinationFormat
60-
job.DmlStats
61-
job.Encoding
62-
job.OperationType
63-
job.QueryPlanEntry
64-
job.QueryPlanEntryStep
65-
job.QueryPriority
66-
job.ReservationUsage
67-
job.SourceFormat
68-
job.WriteDisposition
69-
job.SchemaUpdateOption
24+
.. automodule:: google.cloud.bigquery.job
7025

7126
.. toctree::
7227
:maxdepth: 2
@@ -77,63 +32,28 @@ Job-Related Types
7732
Dataset
7833
=======
7934

80-
.. autosummary::
81-
:toctree: generated
82-
83-
dataset.Dataset
84-
dataset.DatasetListItem
85-
dataset.DatasetReference
86-
dataset.AccessEntry
35+
.. automodule:: google.cloud.bigquery.dataset
8736

8837

8938
Table
9039
=====
9140

92-
.. autosummary::
93-
:toctree: generated
94-
95-
table.PartitionRange
96-
table.RangePartitioning
97-
table.Row
98-
table.RowIterator
99-
table.SnapshotDefinition
100-
table.CloneDefinition
101-
table.Table
102-
table.TableListItem
103-
table.TableReference
104-
table.TimePartitioning
105-
table.TimePartitioningType
41+
.. automodule:: google.cloud.bigquery.table
10642

10743
Model
10844
=====
10945

110-
.. autosummary::
111-
:toctree: generated
112-
113-
model.Model
114-
model.ModelReference
46+
.. automodule:: google.cloud.bigquery.model
11547

11648
Routine
11749
=======
11850

119-
.. autosummary::
120-
:toctree: generated
121-
122-
routine.DeterminismLevel
123-
routine.Routine
124-
routine.RoutineArgument
125-
routine.RoutineReference
126-
routine.RoutineType
51+
.. automodule:: google.cloud.bigquery.routine
12752

12853
Schema
12954
======
13055

131-
.. autosummary::
132-
:toctree: generated
133-
134-
schema.SchemaField
135-
schema.PolicyTagList
136-
56+
.. automodule:: google.cloud.bigquery.schema
13757

13858
Query
13959
=====
@@ -147,25 +67,13 @@ Query
14767
Retries
14868
=======
14969

150-
.. autosummary::
151-
:toctree: generated
152-
153-
retry.DEFAULT_RETRY
70+
.. automodule:: google.cloud.bigquery.retry
15471

15572

15673
External Configuration
15774
======================
15875

159-
.. autosummary::
160-
:toctree: generated
161-
162-
external_config.ExternalSourceFormat
163-
external_config.ExternalConfig
164-
external_config.BigtableOptions
165-
external_config.BigtableColumnFamily
166-
external_config.BigtableColumn
167-
external_config.CSVOptions
168-
external_config.GoogleSheetsOptions
76+
.. automodule:: google.cloud.bigquery.external_config
16977

17078
.. toctree::
17179
:maxdepth: 2
@@ -194,10 +102,7 @@ Enums
194102
Encryption Configuration
195103
========================
196104

197-
.. autosummary::
198-
:toctree: generated
199-
200-
encryption_configuration.EncryptionConfiguration
105+
.. automodule:: google.cloud.bigquery.encryption_configuration
201106

202107

203108
Additional Types

‎noxfile.py

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -418,7 +418,20 @@ def blacken(session):
418418
def docs(session):
419419
"""Build the docs."""
420420

421-
session.install("recommonmark", "sphinx==4.0.2", "sphinx_rtd_theme")
421+
session.install(
422+
# We need to pin to specific versions of the `sphinxcontrib-*` packages
423+
# which still support sphinx 4.x.
424+
# See https://github.com/googleapis/sphinx-docfx-yaml/issues/344
425+
# and https://github.com/googleapis/sphinx-docfx-yaml/issues/345.
426+
"sphinxcontrib-applehelp==1.0.4",
427+
"sphinxcontrib-devhelp==1.0.2",
428+
"sphinxcontrib-htmlhelp==2.0.1",
429+
"sphinxcontrib-qthelp==1.0.3",
430+
"sphinxcontrib-serializinghtml==1.1.5",
431+
"sphinx==4.5.0",
432+
"alabaster",
433+
"recommonmark",
434+
)
422435
session.install("google-cloud-storage")
423436
session.install("-e", ".[all]")
424437

@@ -443,6 +456,15 @@ def docfx(session):
443456

444457
session.install("-e", ".")
445458
session.install(
459+
# We need to pin to specific versions of the `sphinxcontrib-*` packages
460+
# which still support sphinx 4.x.
461+
# See https://github.com/googleapis/sphinx-docfx-yaml/issues/344
462+
# and https://github.com/googleapis/sphinx-docfx-yaml/issues/345.
463+
"sphinxcontrib-applehelp==1.0.4",
464+
"sphinxcontrib-devhelp==1.0.2",
465+
"sphinxcontrib-htmlhelp==2.0.1",
466+
"sphinxcontrib-qthelp==1.0.3",
467+
"sphinxcontrib-serializinghtml==1.1.5",
446468
"gcp-sphinx-docfx-yaml",
447469
"alabaster",
448470
"recommonmark",

0 commit comments

Comments
 (0)