Skip to content

Commit

Permalink
Doc updates in getting_started.rst and flask.rst.
Browse files Browse the repository at this point in the history
  • Loading branch information
Pat Daburu committed Feb 12, 2019
1 parent 7d57b7f commit a67ba22
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 11 deletions.
20 changes: 10 additions & 10 deletions docs/source/flask.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ on the application's configuration object called
`from_object() <http://flask.pocoo.org/docs/1.0/config/#configuring-from-files>`_.

Sticking with that convention, the
:py:class:`ElasticsearchConnection <elastalk.client.ElasticsearchConnection>` in this
library has :py:attr:`config <elastalk.client.ElasticsearchConnection.config>` attribute
which returns an :py:class:`ElasticsearchConf <elastalk.config.ElasticsearchConf>`.
:py:class:`ElastalkConnection <elastalk.connect.ElastalkConnection>` in this
library has :py:attr:`config <elastalk.connect.ElastalkConnection.config>` attribute
which returns an :py:class:`ElastalkConf <elastalk.config.ElastalkConf>`.
Like the Flask configuration object, this configuration object supports a method called
:py:func:`from_object <elastalk.config.ElasticsearchConf.from_object>` that mirrors the
:py:func:`from_object <elastalk.config.ElastalkConf.from_object>` that mirrors the
behavior of the Flask method.

Configuration Options
Expand All @@ -43,25 +43,25 @@ settings from an object.

.. seealso::

:py:attr:`ElasticsearchConf.seeds <elastalk.config.ElasticsearchConf.sniff_on_start>`
:py:attr:`ElasticsearchConf.seeds <elastalk.config.ElastalkConf.sniff_on_start>`

:ES_SNIFF_ON_START: See
`Sniffing on startup <https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/sniffing-on-startup.html>`_
and :py:attr:`ElasticsearchConf.sniff_on_start <elastalk.config.ElasticsearchConf.sniff_on_start>`
and :py:attr:`ElastalkConf.sniff_on_start <elastalk.config.ElastalkConf.sniff_on_start>`

:ES_SNIFF_ON_CONNECTION_FAIL: See
`Sniffing on connection failure <https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/sniffing-on-connection-failure.html>`_
and :py:attr:`ElasticsearchConf.sniff_on_connection_fail <elastalk.config.ElasticsearchConf.sniff_on_connection_fail>`
and :py:attr:`ElastalkConf.sniff_on_connection_fail <elastalk.config.ElastalkConf.sniff_on_connection_fail>`

:ES_SNIFFER_TIMEOUT: See
`Python Elasticsearch Client <https://elasticsearch-py.readthedocs.io/en/master/index.html?highlight=sniffer_timeout>`_
and :py:attr:`ElasticsearchConf.sniffer_timeout <elastalk.config.ElasticsearchConf.sniffer_timeout>`
and :py:attr:`ElastalkConf.sniffer_timeout <elastalk.config.ElastalkConf.sniffer_timeout>`

:ES_MAXSIZE: the maximum number of concurrent connections the client may make

.. seealso::

:py:attr:`ElasticsearchConf.maxsize <elastalk.config.ElasticsearchConf.maxsize>`
:py:attr:`ElasticsearchConf.maxsize <elastalk.config.ElastalkConf.maxsize>`

:ES_MAPPING_FIELD_LIMIT: the maximum number of fields in an index

Expand All @@ -71,7 +71,7 @@ settings from an object.

.. seealso::

* :py:attr:`ElasticsearchConf.mapping_field_limit <elastalk.config.ElasticsearchConf.mapping_field_limit>`
* :py:attr:`ElastalkConf.mapping_field_limit <elastalk.config.ElastalkConf.mapping_field_limit>`
* `Elasticsearch Mapping <https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html#mapping>`_


Expand Down
2 changes: 1 addition & 1 deletion docs/source/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ To get started with Kibana, consult the
`Kibana docs <https://www.elastic.co/guide/en/kibana/current/getting-started.html>`_.

Installing the Library
======================
----------------------

You can use pip to install `elastalk`.

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"owner_": "3ab2b4e5-6992-43f0-851e-d1f42262cd55",
"group_": "5bc9ad2d-7f72-452c-b32a-d699b20d2b1f",
"name": "Mittens"
}

0 comments on commit a67ba22

Please sign in to comment.