Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make inheritance from proto.Message clear in docs #679

Closed
busunkim96 opened this issue Oct 21, 2020 · 1 comment · Fixed by #680
Closed

Make inheritance from proto.Message clear in docs #679

busunkim96 opened this issue Oct 21, 2020 · 1 comment · Fixed by #680
Assignees
Labels
type: docs Improvement to the documentation for an API.

Comments

@busunkim96
Copy link
Contributor

We've been seeing an influx of issues of folks trying to serialize/deserialize messages using the protobuf methods. I think part of the problem is that it's not clear the underlying type has changed from looking at the generated docs.

googleapis/python-vision#64
googleapis/python-vision#70
googleapis/python-memcache#19

image

@busunkim96 busunkim96 added the type: docs Improvement to the documentation for an API. label Oct 21, 2020
@busunkim96
Copy link
Contributor Author

busunkim96 commented Oct 21, 2020

image

Types for Google Cloud Datacatalog v1 API
=========================================

.. automodule:: google.cloud.datacatalog_v1.types
    :members:
    :show-inheritance:

Adding show-inheritance seems to do the trick. The remaining problem is that it is not linkified. Intersphinx seems to be failing to retrieve the objects.inv for proto-plus.

[autosummary] generating autosummary for: README.rst, UPGRADING.md, changelog.md, datacatalog_v1/services.rst, datacatalog_v1/types.rst, datacatalog_v1beta1/services.rst, datacatalog_v1beta1/types.rst, index.rst, multiprocessing.rst
loading intersphinx inventory from http://python.readthedocs.org/en/latest/objects.inv...
loading intersphinx inventory from https://google-auth.readthedocs.io/en/stable/objects.inv...
loading intersphinx inventory from https://googleapis.dev/python/google-api-core/latest/objects.inv...
loading intersphinx inventory from https://grpc.io/grpc/python/objects.inv...
loading intersphinx inventory from https://proto-plus-python.readthedocs.io/...
intersphinx inventory has moved: http://python.readthedocs.org/en/latest/objects.inv -> https://python.readthedocs.io/en/latest/objects.inv
intersphinx inventory has moved: https://grpc.io/grpc/python/objects.inv -> https://grpc.github.io/grpc/python/objects.inv
intersphinx inventory has moved: https://proto-plus-python.readthedocs.io/ -> https://proto-plus-python.readthedocs.io/en/stable/
WARNING: failed to reach any of the inventories with the following issues:
intersphinx inventory 'https://proto-plus-python.readthedocs.io/' not readable due to ValueError: unknown or unsupported inventory version: ValueError('invalid inventory header: ')

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs Improvement to the documentation for an API.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants