Doc fixes

2013-09-23 14:42:23 +02:00
parent 6b4935ac2d
commit ff9623e264
2 changed files with 25 additions and 0 deletions
@@ -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:
@@ -57,6 +57,7 @@ Contents
   :maxdepth: 2

   api
+   connection

 License
 -------