diff --git a/docs/conf.py b/docs/conf.py index aec5e247..97dcfac0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -27,7 +27,7 @@ import sys, os # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest'] -autoclass_content = "init" +autoclass_content = "both" # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/elasticsearch/client.py b/elasticsearch/client.py index 8cdbee0a..c1569c13 100644 --- a/elasticsearch/client.py +++ b/elasticsearch/client.py @@ -46,11 +46,12 @@ def query_params(*es_query_params): class Elasticsearch(object): + """ + Elasticsearch low-level client. Provides a straightforward mapping from + Python to ES REST endpoints. + """ def __init__(self, hosts=None, **kwargs): """ - Elasticsearch low-level client. Provides a straightforward mapping from - Python to ES REST endpoints. - :arg hosts: list of nodes we should connect to. Node should be a dictionary ({"host": "localhost", "port": 9200}), the entire dictionary will be passed to the :class:`~elasticsearch.Connection` class as