Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Link to the 7.14.0 ES Python client docs. #1554

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/command_line_reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -663,7 +663,7 @@ By default, the command line reporter will print the results only on standard ou

With this option you can customize Rally's internal Elasticsearch client.

It accepts a list of comma-separated key-value pairs. The key-value pairs have to be delimited by a colon. These options are passed directly to the Elasticsearch Python client API. See `their documentation on a list of supported options <http://elasticsearch-py.readthedocs.io/en/master/api.html#elasticsearch.Elasticsearch>`_.
It accepts a list of comma-separated key-value pairs. The key-value pairs have to be delimited by a colon. These options are passed directly to the Elasticsearch Python client API. See `their documentation on a list of supported options <https://elasticsearch-py.readthedocs.io/en/v{ES_CLIENT_VER}/api.html#elasticsearch>`_.

We support the following data types:

Expand Down
8 changes: 8 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,15 @@ def read_min_python_version():
raise ConfigError(f"Failed building docs as required key [{e}] couldn't be found in the file [{CI_VARS}].")


def get_es_client_version():
import elasticsearch

return ".".join(map(str, elasticsearch.__version__))


GLOBAL_SUBSTITUTIONS = {
"{MIN_PY_VER}": read_min_python_version(),
"{ES_CLIENT_VER}": get_es_client_version(),
}


Expand All @@ -82,6 +89,7 @@ def read_min_es_version():
.. |year| replace:: {year}
.. |MIN_PY_VER| replace:: {read_min_python_version()}
.. |min_es_version| replace:: {read_min_es_version()}
.. |ES_CLIENT_VER| replace:: {get_es_client_version()}
"""

# General information about the project.
Expand Down