This is an automated email from the ASF dual-hosted git repository. isapego pushed a commit to branch ignite-17023 in repository https://gitbox.apache.org/repos/asf/ignite-python-thin-client.git
commit f45a6f788c85726230cd2786557723be9d651adf Author: Igor Sapego <[email protected]> AuthorDate: Thu May 26 01:22:27 2022 -0700 IGNITE-17023 Fix documentation --- .gitignore | 1 + docs/readme.rst | 2 +- docs/source/pyignite.connection.protocol_context.rst | 2 +- examples/docker-compose.yml | 7 ++----- examples/readme.md | 6 +++++- pyignite/monitoring.py | 2 -- requirements/docs.txt | 2 +- 7 files changed, 11 insertions(+), 11 deletions(-) diff --git a/.gitignore b/.gitignore index 14ec495..7576fcd 100644 --- a/.gitignore +++ b/.gitignore @@ -13,3 +13,4 @@ junit*.xml pyignite.egg-info ignite-log-* __pycache__ +venv diff --git a/docs/readme.rst b/docs/readme.rst index 3e9bec6..17eb4b5 100644 --- a/docs/readme.rst +++ b/docs/readme.rst @@ -37,7 +37,7 @@ Prerequisites - *Python 3.7* or above (3.7, 3.8, 3.9 and 3.10 are tested), - Access to *Apache Ignite* node, local or remote. The current thin client - version was tested on *Apache Ignite 2.10.0* (binary client protocol 1.7.0). + version was tested on *Apache Ignite 2.13.0* (binary client protocol 1.7.0). Installation ------------ diff --git a/docs/source/pyignite.connection.protocol_context.rst b/docs/source/pyignite.connection.protocol_context.rst index a5298ba..1ec3c81 100644 --- a/docs/source/pyignite.connection.protocol_context.rst +++ b/docs/source/pyignite.connection.protocol_context.rst @@ -14,7 +14,7 @@ limitations under the License. pyignite.connection.protocol_context package -=========================== +============================================ .. automodule:: pyignite.connection.protocol_context :members: \ No newline at end of file diff --git a/examples/docker-compose.yml b/examples/docker-compose.yml index f3071b8..e2dd178 100644 --- a/examples/docker-compose.yml +++ b/examples/docker-compose.yml @@ -20,18 +20,15 @@ services: ports: - 10800:10800 restart: always - network_mode: host ignite_1: image: apacheignite/ignite:latest ports: - - 10800:10801 + - 10801:10800 restart: always - network_mode: host ignite_2: image: apacheignite/ignite:latest ports: - - 10800:10802 + - 10802:10800 restart: always - network_mode: host diff --git a/examples/readme.md b/examples/readme.md index 8fd4848..ebc6b7b 100644 --- a/examples/readme.md +++ b/examples/readme.md @@ -2,12 +2,16 @@ This directory contains the following example files: +- `async_key_value` - asynchronous key-value operations, +- `async_sql` - asynchronous SQL operations, - `binary_basics.py` − basic operations with Complex objects, -- `binary_types.py` - read SQL table as a key-value cache, - `create_binary.py` − create SQL row with key-value operation, +- `expiry_policy.py` - the expiration policy for caches for synchronous and asynchronous operations is demonstrated, - `failover.py` − fail-over connection to Ignite cluster, - `get_and_put.py` − basic key-value operations, +- `get_and_put_complex.py` − key-value operations with different value and key types, - `migrate_binary.py` − work with Complex object schemas, +- `read_binary.py` − creates caches and fills them with data through SQL queries, demonstrates working with binary objects, - `scans.py` − cache scan operation, - `sql.py` − use Ignite SQL, - `type_hints.py` − type hints. diff --git a/pyignite/monitoring.py b/pyignite/monitoring.py index 9bbfd20..997a5f8 100644 --- a/pyignite/monitoring.py +++ b/pyignite/monitoring.py @@ -56,8 +56,6 @@ Event listeners can be registered by passing parameter to :class:`~pyignite.clie .. note:: Debug logging is also available, standard ``logging`` is used. Just set ``DEBUG`` level to *pyignite* logger. -| -| """ from typing import Optional, Sequence diff --git a/requirements/docs.txt b/requirements/docs.txt index 2bf167e..d088fff 100644 --- a/requirements/docs.txt +++ b/requirements/docs.txt @@ -3,5 +3,5 @@ -r install.txt wheel==0.36.2 -Sphinx==4.1.2 +Sphinx==4.3.2 sphinxcontrib-fulltoc==1.2.0 \ No newline at end of file
