From b1b669300f570094f0d1c1c5f80df835d69624c4 Mon Sep 17 00:00:00 2001 From: Lidi Zheng Date: Mon, 12 Nov 2018 13:45:01 -0800 Subject: Update Python documentation * Reorganize the section titles * Add Tutorial and Example --- doc/python/sphinx/api.rst | 153 --------------------------------------- doc/python/sphinx/grpc.rst | 169 ++++++++++++++++++++++++++++++++++++++++++++ doc/python/sphinx/index.rst | 2 +- 3 files changed, 170 insertions(+), 154 deletions(-) delete mode 100644 doc/python/sphinx/api.rst create mode 100644 doc/python/sphinx/grpc.rst (limited to 'doc') diff --git a/doc/python/sphinx/api.rst b/doc/python/sphinx/api.rst deleted file mode 100644 index 425504fb28..0000000000 --- a/doc/python/sphinx/api.rst +++ /dev/null @@ -1,153 +0,0 @@ -API Reference -============= - -.. module:: grpc - -Create Client -------------- - -.. autofunction:: insecure_channel -.. autofunction:: secure_channel -.. autofunction:: intercept_channel - - -Create Client Credentials -------------------------- - -.. autofunction:: ssl_channel_credentials -.. autofunction:: metadata_call_credentials -.. autofunction:: access_token_call_credentials -.. autofunction:: composite_call_credentials -.. autofunction:: composite_channel_credentials - - -Create Server -------------- - -.. autofunction:: server - - -Create Server Credentials -------------------------- - -.. autofunction:: ssl_server_credentials -.. autofunction:: ssl_server_certificate_configuration -.. autofunction:: dynamic_ssl_server_credentials - - -RPC Method Handlers --------------------------- - -.. autofunction:: unary_unary_rpc_method_handler -.. autofunction:: unary_stream_rpc_method_handler -.. autofunction:: stream_unary_rpc_method_handler -.. autofunction:: stream_stream_rpc_method_handler -.. autofunction:: method_handlers_generic_handler - - -Channel Ready Future --------------------------- - -.. autofunction:: channel_ready_future - - -Channel Connectivity --------------------------- - -.. autoclass:: ChannelConnectivity - - -gRPC Status Code --------------------------- - -.. autoclass:: StatusCode - - -Channel Object --------------- - -.. autoclass:: Channel - - -Server Object -------------- - -.. autoclass:: Server - - -Authentication & Authorization Objects --------------------------------------- - -.. autoclass:: ChannelCredentials -.. autoclass:: CallCredentials -.. autoclass:: AuthMetadataContext -.. autoclass:: AuthMetadataPluginCallback -.. autoclass:: AuthMetadataPlugin -.. autoclass:: ServerCredentials -.. autoclass:: ServerCertificateConfiguration - - -gRPC Exceptions ---------------- - -.. autoexception:: RpcError - - -Shared Context --------------- - -.. autoclass:: RpcContext - - -Client-Side Context ------------------------ - -.. autoclass:: Call - - -Client-Side Interceptor ------------------------------------------------- - -.. autoclass:: ClientCallDetails -.. autoclass:: UnaryUnaryClientInterceptor -.. autoclass:: UnaryStreamClientInterceptor -.. autoclass:: StreamUnaryClientInterceptor -.. autoclass:: StreamStreamClientInterceptor - - -Service-Side Context --------------------- - -.. autoclass:: ServicerContext - - -Service-Side Handler -------------------------------- - -.. autoclass:: RpcMethodHandler -.. autoclass:: HandlerCallDetails -.. autoclass:: GenericRpcHandler -.. autoclass:: ServiceRpcHandler - - -Service-Side Interceptor ------------------------- - -.. autoclass:: ServerInterceptor - - -Multi-Callable -------------------------- - -.. autoclass:: UnaryUnaryMultiCallable -.. autoclass:: UnaryStreamMultiCallable -.. autoclass:: StreamUnaryMultiCallable -.. autoclass:: StreamStreamMultiCallable - - -Future ----------------- - -.. autoexception:: FutureTimeoutError -.. autoexception:: FutureCancelledError -.. autoclass:: Future diff --git a/doc/python/sphinx/grpc.rst b/doc/python/sphinx/grpc.rst new file mode 100644 index 0000000000..bd2df9596b --- /dev/null +++ b/doc/python/sphinx/grpc.rst @@ -0,0 +1,169 @@ +gRPC +============= + +.. module:: grpc + +Tutorial +-------- + +If you want to see gRPC in action first, visit the `Python Quickstart `_. +Or, if you would like dive in with more extensive usage of gRPC Python, check `gRPC Basics - Python `_ out. + + +Example +------- + +Go to `gRPC Python Examples `_ + + +Module Contents +--------------- + +Create Client +^^^^^^^^^^^^^ + +.. autofunction:: insecure_channel +.. autofunction:: secure_channel +.. autofunction:: intercept_channel + + +Create Client Credentials +^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. autofunction:: ssl_channel_credentials +.. autofunction:: metadata_call_credentials +.. autofunction:: access_token_call_credentials +.. autofunction:: composite_call_credentials +.. autofunction:: composite_channel_credentials + + +Create Server +^^^^^^^^^^^^^ + +.. autofunction:: server + + +Create Server Credentials +^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. autofunction:: ssl_server_credentials +.. autofunction:: ssl_server_certificate_configuration +.. autofunction:: dynamic_ssl_server_credentials + + +RPC Method Handlers +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. autofunction:: unary_unary_rpc_method_handler +.. autofunction:: unary_stream_rpc_method_handler +.. autofunction:: stream_unary_rpc_method_handler +.. autofunction:: stream_stream_rpc_method_handler +.. autofunction:: method_handlers_generic_handler + + +Channel Ready Future +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. autofunction:: channel_ready_future + + +Channel Connectivity +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. autoclass:: ChannelConnectivity + + +gRPC Status Code +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. autoclass:: StatusCode + + +Channel Object +^^^^^^^^^^^^^^ + +.. autoclass:: Channel + + +Server Object +^^^^^^^^^^^^^ + +.. autoclass:: Server + + +Authentication & Authorization Objects +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. autoclass:: ChannelCredentials +.. autoclass:: CallCredentials +.. autoclass:: AuthMetadataContext +.. autoclass:: AuthMetadataPluginCallback +.. autoclass:: AuthMetadataPlugin +.. autoclass:: ServerCredentials +.. autoclass:: ServerCertificateConfiguration + + +gRPC Exceptions +^^^^^^^^^^^^^^^ + +.. autoexception:: RpcError + + +Shared Context +^^^^^^^^^^^^^^ + +.. autoclass:: RpcContext + + +Client-Side Context +^^^^^^^^^^^^^^^^^^^^^^^ + +.. autoclass:: Call + + +Client-Side Interceptor +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. autoclass:: ClientCallDetails +.. autoclass:: UnaryUnaryClientInterceptor +.. autoclass:: UnaryStreamClientInterceptor +.. autoclass:: StreamUnaryClientInterceptor +.. autoclass:: StreamStreamClientInterceptor + + +Service-Side Context +^^^^^^^^^^^^^^^^^^^^ + +.. autoclass:: ServicerContext + + +Service-Side Handler +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. autoclass:: RpcMethodHandler +.. autoclass:: HandlerCallDetails +.. autoclass:: GenericRpcHandler +.. autoclass:: ServiceRpcHandler + + +Service-Side Interceptor +^^^^^^^^^^^^^^^^^^^^^^^^ + +.. autoclass:: ServerInterceptor + + +Multi-Callable Interfaces +^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. autoclass:: UnaryUnaryMultiCallable +.. autoclass:: UnaryStreamMultiCallable +.. autoclass:: StreamUnaryMultiCallable +.. autoclass:: StreamStreamMultiCallable + + +Future Interfaces +^^^^^^^^^^^^^^^^^ + +.. autoexception:: FutureTimeoutError +.. autoexception:: FutureCancelledError +.. autoclass:: Future diff --git a/doc/python/sphinx/index.rst b/doc/python/sphinx/index.rst index b602b2934f..322ca33e15 100644 --- a/doc/python/sphinx/index.rst +++ b/doc/python/sphinx/index.rst @@ -9,7 +9,7 @@ API Reference .. toctree:: :caption: Contents: - api + grpc grpc_health_checking grpc_reflection grpc_testing -- cgit v1.2.3