Skip to content

Commit

Permalink
docs: generated message types reference proto-plus (#680)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
software-dov committed Oct 21, 2020
1 parent 7e0c9b2 commit 23327b2
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 1 deletion.
@@ -1,3 +1,4 @@
#! /usr/bin/env python3
{% extends '_base.py.j2' %}
{% block content %}
import argparse
Expand Down
1 change: 1 addition & 0 deletions gapic/templates/docs/%name_%version/types.rst.j2
Expand Up @@ -3,3 +3,4 @@ Types for {{ api.naming.long_name }} {{ api.naming.version }} API

.. automodule:: {{ api.naming.namespace|join('.')|lower }}.{{ api.naming.versioned_module_name }}.types
:members:
:show-inheritance:
1 change: 1 addition & 0 deletions gapic/templates/docs/conf.py.j2
Expand Up @@ -346,6 +346,7 @@ intersphinx_mapping = {
"google.api_core": ("https://googleapis.dev/python/google-api-core/latest/", None),
"grpc": ("https://grpc.io/grpc/python/", None),
"requests": ("http://requests.kennethreitz.org/en/stable/", None),
"proto": ("https://proto-plus-python.readthedocs.io/en/stable", None),
}


Expand Down
@@ -1,3 +1,4 @@
#! /usr/bin/env python3
{% extends '_base.py.j2' %}
{% block content %}
import argparse
Expand Down
2 changes: 1 addition & 1 deletion noxfile.py
Expand Up @@ -229,7 +229,7 @@ def showcase_mypy_alternative_templates(session):
showcase_mypy(session, templates=ADS_TEMPLATES, other_opts=("old-naming",))


@nox.session(python="3.6")
@nox.session(python="3.8")
def docs(session):
"""Build the docs."""

Expand Down

0 comments on commit 23327b2

Please sign in to comment.