Skip to content

Commit 23327b2

Browse files
authored
docs: generated message types reference proto-plus (#680)
Multiple issues have been filed indicating that json marshalling has been broken and the fix is not obvious. This will hopefully be ameliorated by indicating the inheritance from proto.Message, with a link to the appropriate documentation.
1 parent 7e0c9b2 commit 23327b2

File tree

5 files changed

+5
-1
lines changed

5 files changed

+5
-1
lines changed

gapic/ads-templates/scripts/fixup_%name_%version_keywords.py.j2

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
#! /usr/bin/env python3
12
{% extends '_base.py.j2' %}
23
{% block content %}
34
import argparse

gapic/templates/docs/%name_%version/types.rst.j2

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ Types for {{ api.naming.long_name }} {{ api.naming.version }} API
33

44
.. automodule:: {{ api.naming.namespace|join('.')|lower }}.{{ api.naming.versioned_module_name }}.types
55
:members:
6+
:show-inheritance:

gapic/templates/docs/conf.py.j2

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -346,6 +346,7 @@ intersphinx_mapping = {
346346
"google.api_core": ("https://googleapis.dev/python/google-api-core/latest/", None),
347347
"grpc": ("https://grpc.io/grpc/python/", None),
348348
"requests": ("http://requests.kennethreitz.org/en/stable/", None),
349+
"proto": ("https://proto-plus-python.readthedocs.io/en/stable", None),
349350
}
350351

351352

gapic/templates/scripts/fixup_%name_%version_keywords.py.j2

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
#! /usr/bin/env python3
12
{% extends '_base.py.j2' %}
23
{% block content %}
34
import argparse

noxfile.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ def showcase_mypy_alternative_templates(session):
229229
showcase_mypy(session, templates=ADS_TEMPLATES, other_opts=("old-naming",))
230230

231231

232-
@nox.session(python="3.6")
232+
@nox.session(python="3.8")
233233
def docs(session):
234234
"""Build the docs."""
235235

0 commit comments

Comments
 (0)