aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
authorGravatar Lidi Zheng <lidiz@google.com>2018-11-12 13:45:01 -0800
committerGravatar Lidi Zheng <lidiz@google.com>2018-11-12 13:54:53 -0800
commitb1b669300f570094f0d1c1c5f80df835d69624c4 (patch)
tree1187e41566a88bcfd5652610eca878f1c66e18da /doc
parent15be84ac2e77839a97a2e2800e3656079f05ff99 (diff)
Update Python documentation
* Reorganize the section titles * Add Tutorial and Example
Diffstat (limited to 'doc')
-rw-r--r--doc/python/sphinx/grpc.rst (renamed from doc/python/sphinx/api.rst)62
-rw-r--r--doc/python/sphinx/index.rst2
2 files changed, 40 insertions, 24 deletions
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/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