diff options
| author |  Lidi Zheng <scallopsky@gmail.com> | 2018-11-29 16:10:32 -0800 |
|---|---|---|
| committer |  GitHub <noreply@github.com> | 2018-11-29 16:10:32 -0800 |
| commit | 7ef8fc826c52b0c4abeaead633d464197fc0bdf8 (patch) | |
| tree | 86db374a5e189e730fea2fef843b50d37b9846ab /doc | |
| parent | e91e311a736a94e2f9d7ffdb7de4a5249f2b162f (diff) | |
| parent | 69b6c047bc767b4d80e7af4d00ccb7c45b683dae (diff) | |
Merge pull request #17266 from lidizheng/python-channelz
Channelz Python wrapper implementation
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/python/sphinx/conf.py | 3 | ||||
| -rw-r--r-- | doc/python/sphinx/grpc_channelz.rst | 12 | ||||
| -rw-r--r-- | doc/python/sphinx/index.rst | 1 |
3 files changed, 16 insertions, 0 deletions
diff --git a/doc/python/sphinx/conf.py b/doc/python/sphinx/conf.py index 1eb3a5de7f..307c3bdaf6 100644 --- a/doc/python/sphinx/conf.py +++ b/doc/python/sphinx/conf.py @@ -19,6 +19,7 @@ import sys PYTHON_FOLDER = os.path.join(os.path.dirname(os.path.realpath(__file__)), '..', '..', '..', 'src', 'python') sys.path.insert(0, os.path.join(PYTHON_FOLDER, 'grpcio')) +sys.path.insert(0, os.path.join(PYTHON_FOLDER, 'grpcio_channelz')) sys.path.insert(0, os.path.join(PYTHON_FOLDER, 'grpcio_health_checking')) sys.path.insert(0, os.path.join(PYTHON_FOLDER, 'grpcio_reflection')) sys.path.insert(0, os.path.join(PYTHON_FOLDER, 'grpcio_testing')) @@ -63,6 +64,8 @@ autodoc_default_options = { autodoc_mock_imports = [ 'grpc._cython', + 'grpc_channelz.v1.channelz_pb2', + 'grpc_channelz.v1.channelz_pb2_grpc', 'grpc_health.v1.health_pb2', 'grpc_health.v1.health_pb2_grpc', 'grpc_reflection.v1alpha.reflection_pb2', diff --git a/doc/python/sphinx/grpc_channelz.rst b/doc/python/sphinx/grpc_channelz.rst new file mode 100644 index 0000000000..f65793a071 --- /dev/null +++ b/doc/python/sphinx/grpc_channelz.rst @@ -0,0 +1,12 @@ +gRPC Channelz +==================== + +What is gRPC Channelz? +--------------------------------------------- + +Design Document `gRPC Channelz <https://github.com/grpc/proposal/blob/master/A14-channelz.md>`_ + +Module Contents +--------------- + +.. automodule:: grpc_channelz.v1.channelz diff --git a/doc/python/sphinx/index.rst b/doc/python/sphinx/index.rst index 322ca33e15..2f8a47a074 100644 --- a/doc/python/sphinx/index.rst +++ b/doc/python/sphinx/index.rst @@ -10,6 +10,7 @@ API Reference :caption: Contents: grpc + grpc_channelz grpc_health_checking grpc_reflection grpc_testing |