From ff9623e2649c6efef6d018867cf9037aea6b0518 Mon Sep 17 00:00:00 2001 From: Honza Kral Date: Mon, 23 Sep 2013 14:42:23 +0200 Subject: [PATCH] Doc fixes --- docs/connection.rst | 24 ++++++++++++++++++++++++ docs/index.rst | 1 + 2 files changed, 25 insertions(+) create mode 100644 docs/connection.rst diff --git a/docs/connection.rst b/docs/connection.rst new file mode 100644 index 00000000..0c10bb26 --- /dev/null +++ b/docs/connection.rst @@ -0,0 +1,24 @@ +Connection Layer API +==================== + +.. py:module:: elasticsearch + +Transport +--------- + +.. autoclass:: Transport(hosts, connection_class=Urllib3HttpConnection, connection_pool_class=ConnectionPool, nodes_to_host_callback=construct_hosts_list, sniff_on_start=False, sniff_after_requests=None, sniff_on_connection_fail=False, serializer=JSONSerializer(), max_retries=3, ** kwargs) + :members: + + +Connection Pool +--------------- + +.. autoclass:: ConnectionPool(connections, dead_timeout=60, selector_class=RoundRobinSelector, randomize_hosts=True, ** kwargs) + :members: + + +Connection +---------- + +.. autoclass:: Connection + :members: diff --git a/docs/index.rst b/docs/index.rst index 7ba3c1e3..d7377ab2 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -57,6 +57,7 @@ Contents :maxdepth: 2 api + connection License -------