gapic-generator-python icon indicating copy to clipboard operation
gapic-generator-python copied to clipboard

Sphinx warning `Unknown target name: "oneof"` in python-gke-hub , python-compute and python-assured-workloads

Open parthea opened this issue 4 years ago • 2 comments

For python-gke-hub, I added a workaround in owlbot.py here to solve the issue temporarily. See the build log here from python-gke-hub . Also see related discussion here.

sphinx.errors.SphinxWarning: /tmpfs/src/github/python-gke-hub/google/cloud/gkehub_v1/configmanagement_v1/types/configmanagement.py:docstring of google.cloud.gkehub_v1.configmanagement_v1.types.configmanagement.PolicyController:13:Unknown target name: "oneof".

Warning, treated as error:
/tmpfs/src/github/python-gke-hub/google/cloud/gkehub_v1/configmanagement_v1/types/configmanagement.py:docstring of google.cloud.gkehub_v1.configmanagement_v1.types.configmanagement.PolicyController:13:Unknown target name: "oneof".
nox > Command sphinx-build -W -T -N -b html -d docs/_build/doctrees/ docs/ docs/_build/html/ failed with exit code 2

This issue is also in python-compute. See the build log here.

parthea avatar Nov 10 '21 11:11 parthea

I'm also seeing this issue in python-assured-workloads. See source file here. See build log here.

Traceback (most recent call last):
  File "/tmpfs/src/github/python-assured-workloads/.nox/docs/lib/python3.8/site-packages/sphinx/cmd/build.py", line 280, in build_main
    app.build(args.force_all, filenames)
  File "/tmpfs/src/github/python-assured-workloads/.nox/docs/lib/python3.8/site-packages/sphinx/application.py", line 350, in build
    self.builder.build_update()
  File "/tmpfs/src/github/python-assured-workloads/.nox/docs/lib/python3.8/site-packages/sphinx/builders/__init__.py", line 292, in build_update
    self.build(to_build,
  File "/tmpfs/src/github/python-assured-workloads/.nox/docs/lib/python3.8/site-packages/sphinx/builders/__init__.py", line 306, in build
    updated_docnames = set(self.read())
  File "/usr/local/lib/python3.8/contextlib.py", line 120, in __exit__
    next(self.gen)
  File "/tmpfs/src/github/python-assured-workloads/.nox/docs/lib/python3.8/site-packages/sphinx/util/logging.py", line 213, in pending_warnings
    memhandler.flushTo(logger)
  File "/tmpfs/src/github/python-assured-workloads/.nox/docs/lib/python3.8/site-packages/sphinx/util/logging.py", line 178, in flushTo
    logger.handle(record)
  File "/usr/local/lib/python3.8/logging/__init__.py", line 1599, in handle
    self.callHandlers(record)
  File "/usr/local/lib/python3.8/logging/__init__.py", line 1661, in callHandlers
    hdlr.handle(record)
  File "/usr/local/lib/python3.8/logging/__init__.py", line 950, in handle
    rv = self.filter(record)
  File "/usr/local/lib/python3.8/logging/__init__.py", line 811, in filter
    result = f.filter(record)
  File "/tmpfs/src/github/python-assured-workloads/.nox/docs/lib/python3.8/site-packages/sphinx/util/logging.py", line 423, in filter
    raise exc
sphinx.errors.SphinxWarning: /tmpfs/src/github/python-assured-workloads/google/cloud/assuredworkloads_v1/types/assuredworkloads.py:docstring of google.cloud.assuredworkloads_v1.types.assuredworkloads.Workload.SaaEnrollmentResponse:8:Unknown target name: "oneof".

parthea avatar Dec 12 '21 16:12 parthea

Bumping to p3 as there is already a workaround.

parthea avatar May 13 '22 14:05 parthea