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

[Python] generated docstrings for 'google.cloud.container_v1.types.Cluster' break docs build #2449

@tseaver

Description

@tseaver
  File "/home/tseaver/projects/agendaless/Google/src/gcp/.nox/docs/lib/python3.6/site-packages/sphinx/util/logging.py", line 410, in filter
    raise SphinxWarning(location + ":" + message)
sphinx.errors.SphinxWarning: /home/tseaver/projects/agendaless/Google/src/gcp/container/google/cloud/container_v1/types.py:docstring of google.cloud.container_v1.types.Cluster:185:Inline interpreted text or phrase reference start-string without end-string.
> /home/tseaver/projects/agendaless/Google/src/gcp/.nox/docs/lib/python3.6/site-packages/sphinx/util/logging.py(410)filter()
-> raise SphinxWarning(location + ":" + message)
(Pdb) pp location
('/home/tseaver/projects/agendaless/Google/src/gcp/container/google/cloud/container_v1/types.py:docstring 

The actual file containing that docstring is google/cloud/container_v1/proto/cluster_service_pb2.py. The offending bit is:

      current_node_version:
          [Output only] Deprecated, use `NodePool.version </kubernetes-e
          ngine/docs/reference/rest/v1/projects.zones.clusters.nodePool>
          `__ instead. The current version of the node software
          components. If they are currently at multiple versions because
          they're in the process of being upgraded, this reflects the
          minimum version of all nodes.

where the backtick-double-underscore is wrapped away from the closing angle bracket.

Metadata

Metadata

Labels

lang: pythonIssues specific to Python.priority: p3Desirable enhancement or fix. May not be included in next release.type: bugError or flaw in code with unintended results or allowing sub-optimal usage patterns.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions