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

Commit b1a12d2

Browse files
authored
build: fix warnings in docgen (#711)
Resolved all the outstanding warnings from sphinx. Going forward, warnings will be treated as errors since the `-W` flag is being used with `sphinx-build`
1 parent 333cb76 commit b1a12d2

18 files changed

Lines changed: 120 additions & 272 deletions

.trampolinerc

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Copyright 2020 Google LLC
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
# Template for .trampolinerc
16+
17+
# Add required env vars here.
18+
required_envvars+=(
19+
"STAGING_BUCKET"
20+
"V2_STAGING_BUCKET"
21+
)
22+
23+
# Add env vars which are passed down into the container here.
24+
pass_down_envvars+=(
25+
"STAGING_BUCKET"
26+
"V2_STAGING_BUCKET"
27+
"NOX_SESSION"
28+
)
29+
30+
# Prevent unintentional override on the default image.
31+
if [[ "${TRAMPOLINE_IMAGE_UPLOAD:-false}" == "true" ]] && \
32+
[[ -z "${TRAMPOLINE_IMAGE:-}" ]]; then
33+
echo "Please set TRAMPOLINE_IMAGE if you want to upload the Docker image."
34+
exit 1
35+
fi
36+
37+
# Define the default value if it makes sense.
38+
if [[ -z "${TRAMPOLINE_IMAGE_UPLOAD:-}" ]]; then
39+
TRAMPOLINE_IMAGE_UPLOAD=""
40+
fi
41+
42+
if [[ -z "${TRAMPOLINE_IMAGE:-}" ]]; then
43+
TRAMPOLINE_IMAGE=""
44+
fi
45+
46+
if [[ -z "${TRAMPOLINE_DOCKERFILE:-}" ]]; then
47+
TRAMPOLINE_DOCKERFILE=""
48+
fi
49+
50+
if [[ -z "${TRAMPOLINE_BUILD_FILE:-}" ]]; then
51+
TRAMPOLINE_BUILD_FILE=""
52+
fi

docs/Makefile

Lines changed: 0 additions & 225 deletions
This file was deleted.

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -369,7 +369,7 @@
369369
"python": ("https://docs.python.org/3.5", None),
370370
"urllib3": ("https://urllib3.readthedocs.io/en/stable", None),
371371
"requests": ("https://requests.kennethreitz.org/en/master/", None),
372-
"requests-oauthlib": ("http://requests-oauthlib.readthedocs.io/en/stable", None),
372+
"requests-oauthlib": ("https://requests-oauthlib.readthedocs.io/en/stable/", None),
373373
}
374374

375375
# Autodoc config
File renamed without changes.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
google.auth.jwt\_async module
22
=============================
33

4-
.. automodule:: google.auth.jwt_async
4+
.. automodule:: google.auth._jwt_async
55
:members:
66
:inherited-members:
77
:show-inheritance:

docs/reference/google.auth.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,4 @@ Submodules
3333
google.auth.identity_pool
3434
google.auth.impersonated_credentials
3535
google.auth.jwt
36-
google.auth.jwt_async
36+
google.auth._jwt_async

docs/reference/google.auth.transport.aiohttp_requests.rst renamed to docs/reference/google.auth.transport._aiohttp_requests.rst

File renamed without changes.
File renamed without changes.

docs/reference/google.oauth2.service_account_async.rst renamed to docs/reference/google.oauth2._service_account_async.rst

File renamed without changes.

docs/user-guide.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -520,7 +520,6 @@ A sample end-to-end flow using an ID Token against a Cloud Run endpoint maybe ::
520520
.. _App Engine: https://cloud.google.com/appengine/
521521
.. _Cloud Functions: https://cloud.google.com/functions/
522522
.. _Cloud Run: https://cloud.google.com/run/
523-
.. _Compute Engine: https://cloud.google.com/compute/
524523
.. _Identity Aware Proxy: https://cloud.google.com/iap/
525524
.. _Google OpenID Connect: https://developers.google.com/identity/protocols/OpenIDConnect
526525
.. _Google ID Token: https://developers.google.com/identity/protocols/OpenIDConnect#validatinganidtoken

0 commit comments

Comments
 (0)