Update all rST :: to code-block directives

Author: mesejo

.gitignore

@@ -1,17 +1,145 @@
-.eggs/*
-.*.swp
-*~
-*.py[co]
-.coverage
-test_elasticsearch/cover
-test_elasticsearch/local.py
-docs/_build
-elasticsearch.egg-info
-.tox
-.noseids
-dist
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
 *.egg
-coverage.xml
+MANIFEST
+
+# PyInstaller
+# Usually these files are written by a python script from a template
+# before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
 nosetests.xml
-junit-*.xml
-build
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+# For a library or package, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+# However, in case of collaboration, if having platform-specific dependencies or dependencies
+# having no cross-platform support, pipenv may install dependencies that don't work, or not
+# install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# Pycharm project settings
+.idea
+
+# elasticsearch files
+test_elasticsearch/cover
+test_elasticsearch/local.py

Changelog.rst

@@ -46,7 +46,6 @@ Changelog
 
  .. _#1169: https://github.com/elastic/elasticsearch-py/pull/1169
  .. _#1179: https://github.com/elastic/elasticsearch-py/pull/1179
- .. _#1180: https://github.com/elastic/elasticsearch-py/pull/1180
  .. _#1182: https://github.com/elastic/elasticsearch-py/pull/1182
 
 7.6.0 (2020-03-19)

docs/api.rst

@@ -30,7 +30,9 @@ elasticsearch returns a 2XX response. Otherwise an instance of
 raised. You can see other exception and error states in :ref:`exceptions`. If
 you do not wish an exception to be raised you can always pass in an ``ignore``
 parameter with either a single status code that should be ignored or a list of
-them::
+them:
+
+.. code-block:: python
 
  from elasticsearch import Elasticsearch
  es = Elasticsearch()
@@ -49,7 +51,9 @@ Global timeout can be set when constructing the client (see
 :class:`~elasticsearch.Connection`'s ``timeout`` parameter) or on a per-request
 basis using ``request_timeout`` (float value in seconds) as part of any API
 call, this value will get passed to the ``perform_request`` method of the
-connection class::
+connection class:
+
+.. code-block:: python
 
  # only wait for 1 second, regardless of the client's default
  es.cluster.health(wait_for_status='yellow', request_timeout=1)
@@ -85,12 +89,16 @@ Response Filtering
 ~~~~~~~~~~~~~~~~~~
 
 The ``filter_path`` parameter is used to reduce the response returned by
-elasticsearch. For example, to only return ``_id`` and ``_type``, do::
+elasticsearch. For example, to only return ``_id`` and ``_type``, do:
+
+.. code-block:: python
 
  es.search(index='test-index', filter_path=['hits.hits._id', 'hits.hits._type'])
 
 It also supports the ``*`` wildcard character to match any field or part of a
-field's name::
+field's name:
+
+.. code-block:: python
 
  es.search(index='test-index', filter_path=['hits.hits._*'])
 

docs/conf.py

@@ -142,7 +142,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
+# html_static_path = []
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.

docs/connection.rst

@@ -49,7 +49,9 @@ If you have complex SSL logic for connecting to Elasticsearch using an `SSLConte
 might be more helpful. You can create one natively using the python SSL library with the
 `create_default_context` (https://docs.python.org/3/library/ssl.html#ssl.create_default_context) method.
 
-To create an `SSLContext` object you only need to use one of cafile, capath or cadata::
+To create an `SSLContext` object you only need to use one of cafile, capath or cadata:
+
+.. code-block:: python
 
  >>> from ssl import create_default_context
  >>> context = create_default_context(cafile=None, capath=None, cadata=None)

docs/index.rst

@@ -10,12 +10,16 @@ Installation
 ------------
 
 Install the ``elasticsearch`` package with `pip
-<https://pypi.org/project/elasticsearch>`_::
+<https://pypi.org/project/elasticsearch>`_:
+
+.. code-block:: console
 
  $ python -m pip install elasticsearch
 
 If your application uses async/await in Python you can install with
-the ``async`` extra::
+the ``async`` extra:
+
+.. code-block:: console
 
  $ python -m pip install elasticsearch[async]
 
@@ -41,7 +45,9 @@ For **Elasticsearch 2.0** and later, use the major version 2 (``2.x.y``) of the
 library, and so on.
 
 The recommended way to set your requirements in your `setup.py` or
-`requirements.txt` is::
+`requirements.txt` is:
+
+.. code-block:: python
 
  # Elasticsearch 7.x
  elasticsearch>=7.0.0,<8.0.0
@@ -62,7 +68,7 @@ versions are also released as ``elasticsearch2``, ``elasticsearch5`` and ``elast
 Example Usage
 -------------
 
-::
+.. code-block:: python
 
  from datetime import datetime
  from elasticsearch import Elasticsearch
@@ -177,7 +183,9 @@ location.
 
 By default we allow ``urllib3`` to open up to 10 connections to each node, if
 your application calls for more parallelism, use the ``maxsize`` parameter to
-raise the limit::
+raise the limit:
+
+.. code-block:: python
 
  # allow up to 25 connections to each node
  es = Elasticsearch(["host1", "host2"], maxsize=25)
@@ -194,7 +202,9 @@ SSL and Authentication
 ~~~~~~~~~~~~~~~~~~~~~~
 
 You can configure the client to use ``SSL`` for connecting to your
-elasticsearch cluster, including certificate verification and HTTP auth::
+elasticsearch cluster, including certificate verification and HTTP auth:
+
+.. code-block:: python
 
  from elasticsearch import Elasticsearch
 
@@ -310,7 +320,9 @@ your configuration this might be something you don't want or break completely.
 In some environments (notably on Google App Engine) your HTTP requests might be
 restricted so that ``GET`` requests won't accept body. In that case use the
 ``send_get_body_as`` parameter of :class:`~elasticsearch.Transport` to send all
-bodies via post::
+bodies via post:
+
+.. code-block:: python
 
  from elasticsearch import Elasticsearch
  es = Elasticsearch(send_get_body_as='POST')
@@ -320,7 +332,8 @@ Compression
 When using capacity-constrained networks (low throughput), it may be handy to enable
 compression. This is especially useful when doing bulk loads or inserting large
 documents. This will configure compression.
-::
+
+.. code-block:: python
 
  from elasticsearch import Elasticsearch
  es = Elasticsearch(hosts, http_compress=True)
@@ -331,7 +344,9 @@ Running on AWS with IAM
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 If you want to use this client with IAM based authentication on AWS you can use
-the `requests-aws4auth`_ package::
+the `requests-aws4auth`_ package:
+
+.. code-block:: python
 
  from elasticsearch import Elasticsearch, RequestsHttpConnection
  from requests_aws4auth import AWS4Auth
@@ -357,7 +372,9 @@ Custom serializers
 ~~~~~~~~~~~~~~~~~~
 
 By default, `JSONSerializer`_ is used to encode all outgoing requests.
-However, you can implement your own custom serializer::
+However, you can implement your own custom serializer
+
+.. code-block:: python
 
  from elasticsearch.serializer import JSONSerializer
 

docs/transports.rst

@@ -9,7 +9,9 @@ it to the constructor of :class:`~elasticsearch.Elasticsearch` as
 :class:`~elasticsearch.connection.RequestsHttpConnection` requires ``requests``
 to be installed.
 
-For example to use the ``requests``-based connection just import it and use it::
+For example to use the ``requests``-based connection just import it and use it:
+
+.. code-block:: python
 
  from elasticsearch import Elasticsearch, RequestsHttpConnection
  es = Elasticsearch(connection_class=RequestsHttpConnection)

test_elasticsearch/README.rst

@@ -26,7 +26,7 @@ To simply run the tests just execute the ``run_tests.py`` script or invoke
  * ``TEST_ES_REPO`` - path to the elasticsearch repo, by default it will look in
  the same directory as ``elasticsearch-py`` is in. It will not be used if
  ``TEST_ES_YAML_DIR`` is specified directly.
- 
+
  * ``TEST_ES_NOFETCH`` - controls if we should fetch new updates to elasticsearch
  repo and reset it's version to the sha used to build the current es server.
  Defaults to ``False`` which means we will fetch the elasticsearch repo and
@@ -46,15 +46,19 @@ Run Elasticsearch in a Container
 
 To run elasticsearch in a container, optionally set the ``ES_VERSION``
 environment evariable to either 5.4, 5.3 or 2.4. ``ES_VERSION`` is defaulted to
-``latest``. Then run ./start_elasticsearch.sh::
+``latest``. Then run ./start_elasticsearch.sh:
+
+.. code-block:: console
 
- export ES_VERSION=5.4
- ./start_elasticsearch.sh
+ $ export ES_VERSION=5.4
+ $ ./start_elasticsearch.sh
 
 
 This will run a version for Elasticsearch in a Docker container suitable for
 running the tests. To check that elasticsearch is running first wait for a
-``healthy`` status in ``docker ps``::
+``healthy`` status in ``docker ps``:
+
+.. code-block:: console
 
  $ docker ps
  CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES