Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Copyright 2025 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.
description: Allow documentation warnings for google-shopping-merchant-accounts due to formatting issue in google/protobuf/empty.proto
url: https://github.com/googleapis/gapic-generator-python/issues/2490
replacements:
- paths: [
packages/google-shopping-merchant-accounts/noxfile.py,
]
before: ' "-W", # warnings as errors\n'
after: ''
count: 1
2 changes: 1 addition & 1 deletion .librarian/state.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3980,7 +3980,7 @@ libraries:
tag_format: '{id}-v{version}'
- id: google-shopping-merchant-accounts
version: 1.2.0
last_generated_commit: 535d161c24965e9ed1a0b27032cc1c8b4beab818
last_generated_commit: 55ab9c6263bafb0ef1aa2d8722d190c1697bcbcb
apis:
- path: google/shopping/merchant/accounts/v1
service_config: merchantapi_v1.yaml
Expand Down
1 change: 0 additions & 1 deletion packages/google-shopping-merchant-accounts/noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -378,7 +378,6 @@ def docs(session):
shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True)
session.run(
"sphinx-build",
"-W", # warnings as errors
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

While removing the -W flag resolves the immediate build failure caused by the upstream issue, it has the side effect of allowing all future documentation warnings to pass silently. This could mask new issues and lead to a decline in documentation quality over time.

A more targeted approach would be to suppress only the specific "Unexpected indentation" warning. This can typically be achieved in the Sphinx conf.py file using the suppress_warnings configuration.

If modifying conf.py is not feasible within the current generator setup, this change is an acceptable workaround. However, it would be beneficial to create a follow-up issue to track implementing a more targeted suppression or to remove this workaround once the upstream issue is resolved.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is only a temporary workaround until googleapis/gapic-generator-python#2490 can be addressed.

"-T", # show full traceback on exception
"-N", # no colors
"-b",
Expand Down
Loading