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`
googleapis · Feb 26, 2021 · b1a12d2 · b1a12d2
1 parent 333cb76
commit b1a12d2
Show file tree

Hide file tree

Showing 18 changed files with 120 additions and 272 deletions.
diff --git a/.trampolinerc b/.trampolinerc
@@ -0,0 +1,52 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Template for .trampolinerc
+
+# Add required env vars here.
+required_envvars+=(
+    "STAGING_BUCKET"
+    "V2_STAGING_BUCKET"
+)
+
+# Add env vars which are passed down into the container here.
+pass_down_envvars+=(
+    "STAGING_BUCKET"
+    "V2_STAGING_BUCKET"
+    "NOX_SESSION"
+)
+
+# Prevent unintentional override on the default image.
+if [[ "${TRAMPOLINE_IMAGE_UPLOAD:-false}" == "true" ]] && \
+   [[ -z "${TRAMPOLINE_IMAGE:-}" ]]; then
+   echo "Please set TRAMPOLINE_IMAGE if you want to upload the Docker image."
+   exit 1
+fi
+
+# Define the default value if it makes sense.
+if [[ -z "${TRAMPOLINE_IMAGE_UPLOAD:-}" ]]; then
+    TRAMPOLINE_IMAGE_UPLOAD=""
+fi
+
+if [[ -z "${TRAMPOLINE_IMAGE:-}" ]]; then
+    TRAMPOLINE_IMAGE=""
+fi
+
+if [[ -z "${TRAMPOLINE_DOCKERFILE:-}" ]]; then
+    TRAMPOLINE_DOCKERFILE=""
+fi
+
+if [[ -z "${TRAMPOLINE_BUILD_FILE:-}" ]]; then
+    TRAMPOLINE_BUILD_FILE=""
+fi
diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/conf.py b/docs/conf.py
@@ -369,7 +369,7 @@
     "python": ("https://docs.python.org/3.5", None),
     "urllib3": ("https://urllib3.readthedocs.io/en/stable", None),
     "requests": ("https://requests.kennethreitz.org/en/master/", None),
-    "requests-oauthlib": ("http://requests-oauthlib.readthedocs.io/en/stable", None),
+    "requests-oauthlib": ("https://requests-oauthlib.readthedocs.io/en/stable/", None),
 }
 
 # Autodoc config

diff --git a/...ference/google.auth.credentials_async.rst → ...erence/google.auth._credentials_async.rst b/...ference/google.auth.credentials_async.rst → ...erence/google.auth._credentials_async.rst
diff --git a/docs/reference/google.auth.jwt_async.rst → docs/reference/google.auth._jwt_async.rst b/docs/reference/google.auth.jwt_async.rst → docs/reference/google.auth._jwt_async.rst
@@ -1,7 +1,7 @@
 google.auth.jwt\_async module
 =============================
 
-.. automodule:: google.auth.jwt_async
+.. automodule:: google.auth._jwt_async
    :members:
    :inherited-members:
    :show-inheritance:
diff --git a/docs/reference/google.auth.rst b/docs/reference/google.auth.rst
@@ -33,4 +33,4 @@ Submodules
    google.auth.identity_pool
    google.auth.impersonated_credentials
    google.auth.jwt
-   google.auth.jwt_async
+   google.auth._jwt_async
diff --git a/...oogle.auth.transport.aiohttp_requests.rst → ...ogle.auth.transport._aiohttp_requests.rst b/...oogle.auth.transport.aiohttp_requests.rst → ...ogle.auth.transport._aiohttp_requests.rst
diff --git a/...rence/google.oauth2.credentials_async.rst → ...ence/google.oauth2._credentials_async.rst b/...rence/google.oauth2.credentials_async.rst → ...ence/google.oauth2._credentials_async.rst
diff --git a/...e/google.oauth2.service_account_async.rst → .../google.oauth2._service_account_async.rst b/...e/google.oauth2.service_account_async.rst → .../google.oauth2._service_account_async.rst
diff --git a/docs/user-guide.rst b/docs/user-guide.rst
@@ -520,7 +520,6 @@ A sample end-to-end flow using an ID Token against a Cloud Run endpoint maybe ::
 .. _App Engine: https://cloud.google.com/appengine/
 .. _Cloud Functions: https://cloud.google.com/functions/
 .. _Cloud Run: https://cloud.google.com/run/
-.. _Compute Engine: https://cloud.google.com/compute/
 .. _Identity Aware Proxy: https://cloud.google.com/iap/
 .. _Google OpenID Connect: https://developers.google.com/identity/protocols/OpenIDConnect
 .. _Google ID Token: https://developers.google.com/identity/protocols/OpenIDConnect#validatinganidtoken

diff --git a/google/auth/crypt/_python_rsa.py b/google/auth/crypt/_python_rsa.py
@@ -88,7 +88,7 @@ def from_string(cls, public_key):
                 x509 public key certificate.
 
         Returns:
-            Verifier: The constructed verifier.
+            google.auth.crypt._python_rsa.RSAVerifier: The constructed verifier.
 
         Raises:
             ValueError: If the public_key can't be parsed.