diff options
Diffstat (limited to 'doc/python')
-rw-r--r-- | doc/python/sphinx/conf.py | 3 | ||||
-rw-r--r-- | doc/python/sphinx/grpc.rst (renamed from doc/python/sphinx/api.rst) | 62 | ||||
-rw-r--r-- | doc/python/sphinx/grpc_channelz.rst | 12 | ||||
-rw-r--r-- | doc/python/sphinx/index.rst | 3 |
4 files changed, 56 insertions, 24 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/api.rst b/doc/python/sphinx/grpc.rst index 425504fb28..bd2df9596b 100644 --- a/doc/python/sphinx/api.rst +++ b/doc/python/sphinx/grpc.rst @@ -1,10 +1,26 @@ -API Reference +gRPC ============= .. module:: grpc +Tutorial +-------- + +If you want to see gRPC in action first, visit the `Python Quickstart <https://grpc.io/docs/quickstart/python.html>`_. +Or, if you would like dive in with more extensive usage of gRPC Python, check `gRPC Basics - Python <https://grpc.io/docs/tutorials/basic/python.html>`_ out. + + +Example +------- + +Go to `gRPC Python Examples <https://github.com/grpc/grpc/tree/master/examples/python>`_ + + +Module Contents +--------------- + Create Client -------------- +^^^^^^^^^^^^^ .. autofunction:: insecure_channel .. autofunction:: secure_channel @@ -12,7 +28,7 @@ Create Client Create Client Credentials -------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^ .. autofunction:: ssl_channel_credentials .. autofunction:: metadata_call_credentials @@ -22,13 +38,13 @@ Create Client Credentials Create Server -------------- +^^^^^^^^^^^^^ .. autofunction:: server Create Server Credentials -------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^ .. autofunction:: ssl_server_credentials .. autofunction:: ssl_server_certificate_configuration @@ -36,7 +52,7 @@ Create Server Credentials RPC Method Handlers --------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^ .. autofunction:: unary_unary_rpc_method_handler .. autofunction:: unary_stream_rpc_method_handler @@ -46,37 +62,37 @@ RPC Method Handlers 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 @@ -88,25 +104,25 @@ Authentication & Authorization Objects gRPC Exceptions ---------------- +^^^^^^^^^^^^^^^ .. autoexception:: RpcError Shared Context --------------- +^^^^^^^^^^^^^^ .. autoclass:: RpcContext Client-Side Context ------------------------ +^^^^^^^^^^^^^^^^^^^^^^^ .. autoclass:: Call Client-Side Interceptor ------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. autoclass:: ClientCallDetails .. autoclass:: UnaryUnaryClientInterceptor @@ -116,13 +132,13 @@ Client-Side Interceptor Service-Side Context --------------------- +^^^^^^^^^^^^^^^^^^^^ .. autoclass:: ServicerContext Service-Side Handler -------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. autoclass:: RpcMethodHandler .. autoclass:: HandlerCallDetails @@ -131,13 +147,13 @@ Service-Side Handler Service-Side Interceptor ------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^ .. autoclass:: ServerInterceptor -Multi-Callable -------------------------- +Multi-Callable Interfaces +^^^^^^^^^^^^^^^^^^^^^^^^^ .. autoclass:: UnaryUnaryMultiCallable .. autoclass:: UnaryStreamMultiCallable @@ -145,8 +161,8 @@ Multi-Callable .. autoclass:: StreamStreamMultiCallable -Future ----------------- +Future Interfaces +^^^^^^^^^^^^^^^^^ .. autoexception:: FutureTimeoutError .. autoexception:: FutureCancelledError 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 b602b2934f..2f8a47a074 100644 --- a/doc/python/sphinx/index.rst +++ b/doc/python/sphinx/index.rst @@ -9,7 +9,8 @@ API Reference .. toctree:: :caption: Contents: - api + grpc + grpc_channelz grpc_health_checking grpc_reflection grpc_testing |